1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
# -*- coding: utf-8 -*-
#
# This file is a part of Fedora-tour http://fedoraproject.org/wiki/Fedora-tour
#
# Copyright (c) 2009 Ryan Rix and Ankur Sinha
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
import io
import os.path
import xml.parsers.expat
import sys
import pprint
"""
This will be expanded
"""
class MenuNode:
parent = False
nodes = list()
nodeType = False
def __init__(self, nodeType):
self.nodeType = nodeType
"""
Each one of these objects represents one section of Fedora-tour and all of the content
which exists below it. The frontend should keep these in a list, ordered by MenuObject.Priority
What this sort of does is create a lazy DOM of menuNode objects where each menuNode has a list of
children and a single parent, linked directly to the object, to create a virtual layout of the XML.
node.nodeType = package
nodes: page 1
nodes: page 2
parent: 0
node.nodeType = Page
parent: Package
content and stuff
node.nodeType = Page
parent: Package
content and stuff
"""
class MenuObject:
isValid = True
currenElement = "powo"
rootNode = False
activeNode = False
"""
These Objects are representations of the <Icon> <DocRoot> <Locale> and <Priority> tags.
"""
Icon = False
IconID = False
DocRoot = False
Locale = False
Priority = False
def __init__(self,package):
"""
Check if the file exists. When calling the constructor from the front end, the absolute path
will have to be passed as an argument; this should probably change in the future.
TODO: add code to support automatic generation of absolute URL when front end passes a package name
"""
if not os.path.isfile(package):
self.isValid = False
return None
"""
Create a parser as outlined at http://docs.python.org/library/pyexpat.html
Basically, the parse has three functions in which it uses, CharacterDataHandler,
StartElementHandler, and EndElementHandler. These functions take, for example, "<Icon>",
"fedora-logo-sprite", and "</Icon>" respectively as arguments and these are used to
create the object.
"""
print "Initializing and starting XML Parser for "+package+"."
self.parser = xml.parsers.expat.ParserCreate()
self.parser.CharacterDataHandler = self.parserCharData
self.parser.StartElementHandler = self.parserStartElement
self.parser.EndElementHandler = self.parserEndElement
self.parser.ParseFile(open(package,"r"))
"""
The contents of IconID specify only the short name of an icon, not the full path; this
function finds the full path of an icon and stores it in self.Icon
"""
self.Icon = self.makeIcon(self.IconID)
def addNode(self,parent,nodeType):
node = MenuNode(nodeType)
if parent != False:
node.parent = parent
parent.nodes.append(node)
return node
"""
This function parses the opening tags in the XML file and sets the proper value in
self.currentElement for the parserCharData method to handle properly. This will probably
a little bit more intuitively in the future, but for now it works.
"""
def parserStartElement(self, name, attrs):
print "Encountered "+name+" node Start"
self.currentElement = name
if name == "Package":
"""
This is always assumed to be the root node.
"""
self.rootNode = self.addNode(False,"Package")
self.activeNode = self.rootNode
elif name == "Page":
"""
The Page entities are new nodes
"""
self.activeNode = self.addNode(self.activeNode, "Page")
elif name == "Icon" or name == "DocRoot" or name == "Locale" or name == "Priority":
"""
These tags are only allowed under root, so we should err if this happens.
"""
if self.activeNode.parent != False:
print "<"+name+"> node is only allowed underneath the <Package> Node. Please file a bug on the Fedora-tour Fedora component at http://bugzilla.redhat.com"
sys.exit()
"""
I'm about 99% sure that this code could be written in a cleaner fashion and not
so damn ugly, but here it is, assigning variables in the object. At some point,
I'll look at moving these to attrs of the Page and Package entities, just so that
the code could be a little bit cleaner. I know for sure that DisplayName could be
in both and that Icon, DocRoot, Locale, and Priority could easily end up under Package.
TODO: Rewrite this to be cleaner.
TODO: Finish handlers for other entities, you missed a few.
"""
def parserCharData(self, data):
if data == "":
return
if self.currentElement == "DisplayName":
self.activeNode.displayName = data
elif self.currentElement == "Icon":
self.IconID = data
elif self.currentElement == "DocRoot":
self.DocRoot = data
elif self.currentElement == "Locale":
self.Locale = data
elif self.currentElement == "Priority":
self.Priority = data
"""
This just checks if a Page element is closing, since that will step us down one
level in the "DOM" tree
"""
def parserEndElement(self, name):
print "Encountered "+name+" node End"
self.currentElement = ""
if name == "Page":
self.activeNode = self.activeNode.parent
"""
TODO
"""
def makeIcon(self, iconID):
pass
menu = MenuObject("../data/package.xml")
print "==========================="
print menu.IconID
print menu.Priority
print menu.DocRoot
|
