SiteMap.inc
8.96 KB
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?php
require_once("$default->owl_fs_root/lib/security/permission.inc");
/**
* $Id$
*
* Maintains (page, access) access map, as well as (section, page) map.
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
* @package lib.session
*/
class SiteMap {
/**
* The underlying site map storage array
*/
var $siteMapArray;
/**
* Constructs a new SiteMap, initialising the array.
*/
function SiteMap() {
$this->siteMapArray = array();
}
/**
* Adds a site page mapping entry.
*
* @param string the controller action
* @param string the corresponding page for this action
* @param string the section this page falls under
* @param string the user group with access to this page
* @param string description of the page for link presentation
*/
function addPage($action, $page, $sectionName, $groupName, $description) {
$this->siteMapArray[$sectionName][$groupName][$action] = array ("page" => $page,
"description" => $description,
"default" => false);
}
/**
* Adds a site page mapping entry- the default page for the section.
*
* @param string the controller action
* @param string the corresponding page for this action
* @param string the section this page falls under
* @param string the user group with access to this page
* @param string description of the page for link presentation
*/
function addDefaultPage($action, $page, $sectionName, $groupName, $description) {
$this->siteMapArray[$sectionName][$groupName][$action] = array ("page" => $page,
"description" => $description,
"default" => true);
}
/**
* Returns the section name of the supplied page
*
* @param string the page to lookup the section for
*/
function getSectionName($sRequiredPage) {
global $default;
// for each section
foreach ($this->siteMapArray as $section => $valArr) {
// for each group, page array combination
foreach ($valArr as $requiredGroupName => $pageArr) {
// now loop through pages until we find the right one
foreach ($pageArr as $action => $page) {
if ($sRequiredPage == $page["page"]) {
return $section;
}
}
}
}
}
/**
* Returns controller links for a section
*
* @param string the section to return links for
*/
function getSectionLinks($sSectionName) {
global $default;
// check if the section exists
if (is_array($this->siteMapArray[$sSectionName])) {
// initialise result array
$results = array("descriptions" => array(), "links" => array());
// need to loop through all (groupName, page) arrays in this section
foreach ($this->siteMapArray[$sSectionName] as $requiredGroupName => $pages) {
// if anonymous
// or the user is in the required group or the user is the SA
if ( ($requiredGroupName == "Anonymous") ||
( Permission::userIsInGroupName($requiredGroupName) ||
Permission::userIsInGroupName("System Administrators") ) ) {
foreach ($pages as $action => $pageDetail) {
// add this array to the resultset array
$results["descriptions"][] = $pages[$action]["description"];
$results["links"][] = generateControllerUrl($action);
}
}
}
// now check if we have anything in the results array before returning it
if (count($results) > 0) {
return $results;
} else {
return false;
}
} else {
$_SESSION["errorMessage"] = "No such section name ($sSectionName) in the sitemap";
return false;
}
}
/**
* Returns the page mapped to the (action, groupName) pair.
*
* @param string the action to lookup pages for
* @return string the page to redirect to, or false if the user doesn't have access to the page
*/
function getPage($action) {
global $default;
$default->log->info("SiteMap::getPage: checking ($action, " . $_SESSION["userID"] . ")");
$groupIDs = array();
// for each section
foreach ($this->siteMapArray as $section => $valArr) {
$default->log->debug("Sitemap::getPage section=$section");
// for each group, page array combination
foreach ($valArr as $requiredGroupName => $pageArr) {
// now loop through pages until we find the right one
foreach ($pageArr as $ackshin => $page) {
if ($ackshin == $action) {
$default->log->debug("Sitemap::getPage current requiredGroup=$requiredGroupName, action=$ackshin");
// if anonymous
// or the user is in the required group or the user is the SA
if ( ($requiredGroupName == "Anonymous") ||
( Permission::userIsInGroupName($requiredGroupName) ||
Permission::userIsInGroupName("System Administrators") ) ) {
return $page["page"];
}
}
}
}
}
// if the function hasn't returned already then the specified
// userGroup does not have access to the action
$default->log->info("Sitemap::getPage: access denied for ($action, " . $_SESSION["userID"] . ")");
return false;
}
/**
* Returns the default action for the supplied section
*
* @param string the section name to return the default action for
* @return string the controller action for the default page for this section
*/
function getDefaultAction($sectionName) {
global $default;
// check if the section exists
if (is_array($this->siteMapArray[$sectionName])) {
// initialise result array
$results = array();
// need to loop through all (groupName, page) arrays in this section
foreach ($this->siteMapArray[$sectionName] as $requiredGroupName => $pages) {
// don't need to check the permissions here, when the controller tries to
// retrieve the page from the action, the perms will be checked
//$default->log->debug("Sitemap::getDefaultAction: (section=$sectionName, reqGrp=$requiredGroupName); pages=" . arrayToString($pages));
foreach ($pages as $action => $pageArray) {
//$default->log->debug("Sitemap::getDefaultAction: action=$action; pageArray" . arrayToString($pageArray));
if ($pageArray["default"]) {
return $action;
}
}
}
} else {
// supplied section not in sitemap
// TODO: internal error code?
$_SESSION["errorMessage"] = "$sectionName not in SiteMap!";
return false;
}
}
/**
* Returns the action for a specific page- to enable redirects
*
* @param string the page to perform the reverse lookup for
* @return string the action for this page
*/
function getActionFromPage($sPage) {
global $default;
$default->log->debug("Sitemap::getActionFromPage: page=$sPage");
// for each section
foreach ($this->siteMapArray as $section => $valArr) {
$default->log->debug("Sitemap::getActionFromPage section=$section");
// for each group, page array combination
foreach ($valArr as $requiredGroupName => $pageArr) {
$default->log->debug("Sitemap::getActionFromPage grp=$requiredGroupName");
// now loop through pages until we find the right one
foreach ($pageArr as $action => $page) {
$default->log->debug("Sitemap::getActionFromPage action=$action, reqPage=$sPage; page=" . $page["page"]);
if ($sPage == $page["page"]) {
$default->log->debug("Sitemap::getActionFromPage found action=$action for page=$sPage");
return $action;
}
}
}
}
}
/**
* Prints the current site map
*/
function printMap() {
return arrayToString($this->siteMapArray);
}
}
?>