DocumentBrowser.inc
12 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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<?php
require_once("$default->fileSystemRoot/lib/security/permission.inc");
require_once("$default->fileSystemRoot/lib/users/User.inc");
require_once("$default->fileSystemRoot/lib/documentmanagement/Document.inc");
require_once("$default->fileSystemRoot/lib/foldermanagement/Folder.inc");
/**
*
* $Id$
*
* Contains document browsing business logic.
*
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
*
* @package lib.documentmanagement
*/
class DocumentBrowser {
var $aSortCriteria = array ( "name" => array ("display" => "Title"),
"filename" => array ("display" => "Filename"),
"creator_id" => array ("display" => "Creator",
"lookup" => array ("lookupTable" => "users",
"lookupField" => "name")),
"modified" => array ("display" => "Modified"),
"document_type_id" => array ("display" => "Document Type",
"lookup" => array ("lookupTable" => "document_types_lookup",
"lookupField" => "name")) );
/**
* Returns the document sort criteria
*/
function getSortCriteria() {
return $this->aSortCriteria;
}
/**
* Browse the documents by folder
*
* @param int the folder to browse from
* @return array folders and documents
*/
function browseByFolder($folderID = -1, $sSortField = "name", $sSortDirection = "asc") {
global $default;
// instantiate and initialise
$results = array();
$sql = $default->db;
// no folder specified, so depending on the users groups, resolve to the right folderID
if ($folderID == -1) {
// no folder specified, so start at the root folder
// look up this users unit
$unitID = User::getUnitID($_SESSION["userID"]);
if ($unitID) {
// if the user is in a unit, start at the unit's root folder
// lookup the unit name
$unitName = lookupField($default->owl_units_table, "name", "id", $unitID);
// the unit root folder has the same name as the unit
// FIXME: dodgy i know, but its easy
$unitRootFolderName = $unitName;
// now lookup the folderID
$aFolders = Folder::getList("name='$unitRootFolderName' and parent_id=1");
if (!$aFolders) {
// no folder exists with this name, so start at the root
$folderID = lookupID($default->owl_folders_table, "parent_id", 0);
} else {
$folderID = $aFolders[0]->getID();
}
} else {
// else just start at the root
// FIXME: start at the root folder for the default organisation
$folderID = lookupID($default->owl_folders_table, "parent_id", 0);
}
}
$default->log->debug("DocumentBrowser::browseByFolder: folderID=$folderID");
// get the folder
$results["folders"][] = & Folder::get($folderID);
if ($results["folders"][0]) {
// now find all the child folders relative to this one
// FIXME: in the same unit?
// if we're sorting by name then sort folders in the appropriate direction
$folderQuery = "SELECT f.id FROM $default->owl_folders_table f ";
if ( $sSortField == "creator_id" ) {
$folderQuery .= "INNER JOIN " . $this->aSortCriteria["creator_id"]["lookup"]["lookupTable"] . " lt ON f.$sSortField=lt.id ";
}
$folderQuery .= "WHERE f.parent_id=$folderID ";
if ( $sSortField == "creator_id" ) {
$folderQuery .= "ORDER BY lt." . $this->aSortCriteria["creator_id"]["lookup"]["lookupField"] . " $sSortDirection";
} else {
$folderQuery .= "ORDER BY name " . ($sSortField == "name" ? $sSortDirection : "ASC");
}
if ($sql->query($folderQuery)) {
while ($sql->next_record()) {
// add the child folders to the array
$results["folders"][] = & Folder::get($sql->f("id"));
}
}
// create query to retrieve documents in this folder
$documentQuery = "SELECT d.id as id FROM $default->owl_documents_table d ";
if ( isset($this->aSortCriteria[$sSortField]["lookup"]) ) {
$documentQuery .= "INNER JOIN " . $this->aSortCriteria[$sSortField]["lookup"]["lookupTable"] . " lt ON d.$sSortField=lt.id ";
}
$documentQuery .= "WHERE d.folder_id=$folderID ";
if ( isset($this->aSortCriteria[$sSortField]["lookup"]) ) {
$documentQuery .= "ORDER BY lt." . $this->aSortCriteria[$sSortField]["lookup"]["lookupField"] . " $sSortDirection";
} else {
$documentQuery .= "ORDER BY $sSortField $sSortDirection";
}
// initialise access flag;
$results["accessDenied"] = false;
if ($sql->query($documentQuery)) {
while ($sql->next_record()) {
// check permissions
if (Permission::userHasDocumentReadPermission($sql->f("id"))) {
// add documents to array
// set file attributes
$results["documents"][] = & Document::get($sql->f("id"));
} else {
// set access denied message
$results["accessDenied"] = true;
}
}
} else {
$_SESSION["errorMessage"] = "documents table select failed";
}
return $results;
} else {
return false;
}
}
/**
* Browse the documents by category
*
* @param string the category to browse
*/
function browseByCategory($category = "", $sSortField = "name", $sSortDirection = "asc") {
global $default;
// TODO: add this to default inserts
$categoryField = "Category";
$results = array();
$sql = $default->db;
// lookup document_fields id for category
$categoryFieldID = lookupID($default->owl_fields_table, "name", "$categoryField");
$default->log->debug("DocumentBrowser::browseByCategory categoryFieldID=$categoryFieldID");
if ($category == "") {
$default->log->debug("DocumentBrowser::browseByCategory no category supplied, returning list");
// no category value supplied, so return a list of categories
// set the first value to "categories"
$results["categories"][] = "Categories";
// get a list of category values
$query = "SELECT DISTINCT value FROM $default->owl_document_fields_table " .
"WHERE document_field_id=$categoryFieldID " .
"ORDER BY value " . ($sSortField == "name" ? $sSortDirection : "ASC");
$sql->query($query);
// loop through resultset, build array and return
while ($sql->next_record()) {
$results["categories"][] = $sql->f("value");
}
// its ok if we return an empty array- the UI's responsibility to check and print an error
return $results;
} else {
$results["categories"][] = $category;
// we have a category to use, so find all the documents
// with this category value
$query = "SELECT df.document_id FROM $default->owl_document_fields_table df " .
"INNER JOIN $default->owl_documents_table d ON df.document_id = d.id ";
if ( isset($this->aSortCriteria[$sSortField]["lookup"]) ) {
$query .= "INNER JOIN " . $this->aSortCriteria[$sSortField]["lookup"]["lookupTable"] . " lt ON d.$sSortField=lt.id ";
}
$query .= "WHERE df.document_field_id = $categoryFieldID AND value='$category' ";
if ( isset($this->aSortCriteria[$sSortField]["lookup"]) ) {
$query .= "ORDER BY lt." . $this->aSortCriteria[$sSortField]["lookup"]["lookupField"] . " $sSortDirection";
} else {
$query .= "ORDER BY d.$sSortField $sSortDirection";
}
$sql->query($query);
// loop through resultset and add to array
$results["accessDenied"] = false;
while ($sql->next_record()) {
// check permissions
if (Permission::userHasDocumentReadPermission($sql->f("document_id"))) {
$results["documents"][] = & Document::get($sql->f("document_id"));
} else {
$results["accessDenied"] = true;
}
}
return $results;
}
}
/**
* Browse the documents by document type
*
* @param int the document type ID to browse
*/
function browseByDocumentType($documentTypeID = -1, $sSortField = "name", $sSortDirection = "asc") {
global $default;
$results = array();
$sql = $default->db;
if ($documentTypeID == -1) {
// no document type idsupplied, so return a list of document types
// set the first value to "Document Types"
$results["documentTypes"][] = array("name" => "Document Types");
// return a list of document types
$query = "SELECT * FROM $default->owl_document_types_table ORDER BY name " . ($sSortField == "name" ? $sSortDirection : "ASC");
$sql->query($query);
while ($sql->next_record()) {
$results["documentTypes"][] = array ("id" => $sql->f("id"), "name" => $sql->f("name"));
}
return $results;
} else {
// lookup document type name from the passed in id
$documentTypeName = lookupField($default->owl_document_types_table, "name", "id", $documentTypeID);
$results["documentTypes"][] = array("id" => $documentTypeID, "name" => $documentTypeName);
// create query to retrieve documents with this document type
$documentQuery = "SELECT d.id as id FROM $default->owl_documents_table d ";
if ( isset($this->aSortCriteria[$sSortField]["lookup"]) ) {
$documentQuery .= "INNER JOIN " . $this->aSortCriteria[$sSortField]["lookup"]["lookupTable"] . " lt ON d.$sSortField=lt.id ";
}
$documentQuery .= "WHERE document_type_id=$documentTypeID ";
if ( isset($this->aSortCriteria[$sSortField]["lookup"]) ) {
$documentQuery .= "ORDER BY lt." . $this->aSortCriteria[$sSortField]["lookup"]["lookupField"] . " $sSortDirection";
} else {
$documentQuery .= "ORDER BY $sSortField $sSortDirection";
}
// loop through resultset and populate array with document objects
$sql->query($documentQuery);
$results["accessDenied"] = false;
while ($sql->next_record()) {
// check permission
if (Permission::userHasDocumentReadPermission($sql->f("id"))) {
$results["documents"][] = & Document::get($sql->f("id"));
} else {
$results["accessDenied"] = true;
}
}
$default->log->debug("DocumentBrowser::browseByDocumentType: results=" . arrayToString($results));
return $results;
}
}
}