5 * Copyright 2005, Anthony J. Pugliese
6 * Copyright 2005, GForge, LLC
7 * Copyright 2009, Roland Mas
8 * Copyright 2009, Alcatel-Lucent
10 * This file is part of FusionForge. FusionForge is free software;
11 * you can redistribute it and/or modify it under the terms of the
12 * GNU General Public License as published by the Free Software
13 * Foundation; either version 2 of the Licence, or (at your option)
16 * FusionForge is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with FusionForge; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 * Standard Alcatel-Lucent disclaimer for contributing to open source
29 * "The Artifact ("Contribution") has not been tested and/or
30 * validated for release as or in products, combinations with products or
31 * other commercial use. Any use of the Contribution is entirely made at
32 * the user's own responsibility and the user can not rely on any features,
33 * functionalities or performances Alcatel-Lucent has attributed to the
36 * THE CONTRIBUTION BY ALCATEL-LUCENT IS PROVIDED AS IS, WITHOUT WARRANTY
37 * OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
38 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, COMPLIANCE,
39 * NON-INTERFERENCE AND/OR INTERWORKING WITH THE SOFTWARE TO WHICH THE
40 * CONTRIBUTION HAS BEEN MADE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
41 * ALCATEL-LUCENT BE LIABLE FOR ANY DAMAGES OR OTHER LIABLITY, WHETHER IN
42 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
43 * CONTRIBUTION OR THE USE OR OTHER DEALINGS IN THE CONTRIBUTION, WHETHER
44 * TOGETHER WITH THE SOFTWARE TO WHICH THE CONTRIBUTION RELATES OR ON A STAND
48 require_once $gfcommon.'include/Error.class.php';
50 define('ARTIFACT_QUERY_ASSIGNEE',1);
51 define('ARTIFACT_QUERY_STATE',2);
52 define('ARTIFACT_QUERY_MODDATE',3);
53 define('ARTIFACT_QUERY_EXTRAFIELD',4);
54 define('ARTIFACT_QUERY_SORTCOL',5);
55 define('ARTIFACT_QUERY_SORTORD',6);
56 define('ARTIFACT_QUERY_OPENDATE',7);
57 define('ARTIFACT_QUERY_CLOSEDATE',8);
58 define('ARTIFACT_QUERY_SUMMARY',9);
59 define('ARTIFACT_QUERY_DESCRIPTION',10);
60 define('ARTIFACT_QUERY_FOLLOWUPS',11);
61 define('ARTIFACT_QUERY_SUBMITTER',12);
63 require_once $gfcommon.'tracker/ArtifactType.class.php';
65 class ArtifactQuery extends Error {
67 * The artifact type object.
69 * @var object $ArtifactType.
71 var $ArtifactType; //object
74 * Array of artifact data.
76 * @var array $data_array.
81 * Array of query conditions
83 * @var array $element_array.
88 * ArtifactQuery - Constructer
90 * @param object ArtifactType object.
92 * @return boolean success.
94 function __construct(&$ArtifactType, $data = false) {
97 //was ArtifactType legit?
98 if (!$ArtifactType || !is_object($ArtifactType)) {
99 $this->setError('ArtifactQuery: No Valid ArtifactType');
102 //did ArtifactType have an error?
103 if ($ArtifactType->isError()) {
104 $this->setError('ArtifactQuery: '.$ArtifactType->getErrorMessage());
107 $this->ArtifactType =& $ArtifactType;
110 if (is_array($data)) {
111 $this->data_array =& $data;
114 if (!$this->fetchData($data)) {
124 * create - create a row in the table that stores a saved query for
127 * @param string Name of the saved query.
128 * @return true on success / false on failure.
130 function create($name,$status,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange=0,$closedaterange=0,
131 $summary,$description,$followups,$query_type=0,$query_options=array(),$submitter='') {
136 $this->setMissingParamsError();
139 if (!session_loggedin()) {
140 $this->setError('Must Be Logged In');
144 if ($this->Exist(htmlspecialchars($name))) {
145 $this->setError(_('Query already exists'));
149 if ($query_type>0 && !forge_check_perm ('tracker', $this->ArtifactType->getID(), 'manager')) {
150 $this->setError( _('You must have tracker admin rights to set or update a project level query.'));
154 // Reset the project default query.
155 if ($query_type==2) {
156 $res = db_query_params ('UPDATE artifact_query SET query_type=1 WHERE query_type=2 AND group_artifact_id=$1',
157 array($this->ArtifactType->getID()));
159 $this->setError('Error Updating: '.db_error());
165 $result = db_query_params ('INSERT INTO artifact_query (group_artifact_id,query_name,user_id,query_type) VALUES ($1,$2,$3,$4)',
166 array ($this->ArtifactType->getID(),
167 htmlspecialchars($name),
170 if ($result && db_affected_rows($result) > 0) {
172 $id=db_insertid($result,'artifact_query','artifact_query_id');
174 $this->setError('Error getting id '.db_error());
178 if (!$this->insertElements($id,$status,$submitter,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange,$closedaterange,$summary,$description,$followups)) {
184 $this->setError(db_error());
189 // Now set up our internal data structures
191 if ($this->fetchData($id)) {
201 * fetchData - re-fetch the data for this ArtifactQuery from the database.
203 * @param int ID of saved query.
204 * @return boolean success.
206 function fetchData($id) {
207 $res = db_query_params ('SELECT * FROM artifact_query WHERE artifact_query_id=$1',
210 if (!$res || db_numrows($res) < 1) {
211 $this->setError('ArtifactQuery: Invalid ArtifactQuery ID'.db_error());
214 $this->data_array = db_fetch_array($res);
215 db_free_result($res);
216 $res = db_query_params ('SELECT * FROM artifact_query_fields WHERE artifact_query_id=$1',
218 unset($this->element_array);
219 while ($arr = db_fetch_array($res)) {
221 // Some things may have been saved as comma-separated items
223 if (strstr($arr['query_field_values'],',')) {
224 $arr['query_field_values']=explode(',',$arr['query_field_values']);
226 $this->element_array[$arr['query_field_type']][$arr['query_field_id']]=$arr['query_field_values'];
232 * getArtifactType - get the ArtifactType Object this ArtifactExtraField is associated with.
234 * @return object ArtifactType.
236 function &getArtifactType() {
237 return $this->ArtifactType;
244 function insertElements($id,$status,$submitter,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange,$closedaterange,$summary,$description,$followups) {
245 $res = db_query_params ('DELETE FROM artifact_query_fields WHERE artifact_query_id=$1',
248 $this->setError('Deleting Old Elements: '.db_error());
252 $status = intval($status);
253 $res = db_query_params ('INSERT INTO artifact_query_fields (artifact_query_id,query_field_type,query_field_id,query_field_values) VALUES ($1,$2,0,$3)',
255 ARTIFACT_QUERY_STATE,
258 $this->setError('Setting Status: '.db_error());
262 if (is_array($submitter)) {
263 for($e=0; $e<count($submitter); $e++) {
264 $submitter[$e]=intval($submitter[$e]);
266 $submitter=implode(',',$submitter);
268 $submitter = intval($submitter);
271 if (is_array($assignee)) {
272 for($e=0; $e<count($assignee); $e++) {
273 $assignee[$e]=intval($assignee[$e]);
275 $assignee=implode(',',$assignee);
277 $assignee = intval($assignee);
280 if (preg_match("/[^[:alnum:]_]/", $sort_col)) {
281 $this->setError('ArtifactQuery: not valid sort_col');
285 if (preg_match("/[^[:alnum:]_]/", $sort_ord)) {
286 $this->setError('ArtifactQuery: not valid sort_ord');
290 //CSV LIST OF SUBMITTERS
292 $res = db_query_params ('INSERT INTO artifact_query_fields
293 (artifact_query_id,query_field_type,query_field_id,query_field_values)
294 VALUES ($1,$2,0,$3)',
296 ARTIFACT_QUERY_SUBMITTER,
299 $this->setError('Setting Submitter: '.db_error());
304 //CSV LIST OF ASSIGNEES
306 $res = db_query_params ('INSERT INTO artifact_query_fields
307 (artifact_query_id,query_field_type,query_field_id,query_field_values)
308 VALUES ($1,$2,0,$3)',
310 ARTIFACT_QUERY_ASSIGNEE,
313 $this->setError('Setting Assignee: '.db_error());
318 //MOD DATE RANGE YYYY-MM-DD YYYY-MM-DD format
319 if ($moddaterange && !$this->validateDateRange($moddaterange)) {
320 $this->setError('Invalid Mod Date Range');
323 $res = db_query_params ('INSERT INTO artifact_query_fields
324 (artifact_query_id,query_field_type,query_field_id,query_field_values)
325 VALUES ($1,$2,0,$3)',
327 ARTIFACT_QUERY_MODDATE,
330 $this->setError('Setting Last Modified Date Range: '.db_error());
334 //OPEN DATE RANGE YYYY-MM-DD YYYY-MM-DD format
335 if ($opendaterange && !$this->validateDateRange($opendaterange)) {
336 $this->setError('Invalid Open Date Range');
339 $res = db_query_params ('INSERT INTO artifact_query_fields
340 (artifact_query_id,query_field_type,query_field_id,query_field_values)
341 VALUES ($1,$2,0,$3)',
343 ARTIFACT_QUERY_OPENDATE,
346 $this->setError('Setting Open Date Range: '.db_error());
350 //CLOSE DATE RANGE YYYY-MM-DD YYYY-MM-DD format
351 if ($closedaterange && !$this->validateDateRange($closedaterange)) {
352 $this->setError('Invalid Close Date Range');
355 $res = db_query_params ('INSERT INTO artifact_query_fields
356 (artifact_query_id,query_field_type,query_field_id,query_field_values)
357 VALUES ($1,$2,0,$3)',
359 ARTIFACT_QUERY_CLOSEDATE,
362 $this->setError('Setting Close Date Range: '.db_error());
367 $res = db_query_params ('INSERT INTO artifact_query_fields
368 (artifact_query_id,query_field_type,query_field_id,query_field_values)
369 VALUES ($1,$2,0,$3)',
371 ARTIFACT_QUERY_SORTCOL,
374 $this->setError('Setting Sort Col: '.db_error());
377 $res = db_query_params ('INSERT INTO artifact_query_fields
378 (artifact_query_id,query_field_type,query_field_id,query_field_values)
379 VALUES ($1,$2,0,$3)',
381 ARTIFACT_QUERY_SORTORD,
384 $this->setError('Setting Sort Order: '.db_error());
388 // Saving the summary value.
389 $res=db_query_params ('INSERT INTO artifact_query_fields
390 (artifact_query_id,query_field_type,query_field_id,query_field_values)
391 VALUES ($1,$2,$3,$4)',
393 ARTIFACT_QUERY_SUMMARY,
397 $this->setError('Setting Summary: '.db_error());
401 // Saving the description value.
402 $res=db_query_params ('INSERT INTO artifact_query_fields
403 (artifact_query_id,query_field_type,query_field_id,query_field_values)
404 VALUES ($1,$2,$3,$4)',
406 ARTIFACT_QUERY_DESCRIPTION,
410 $this->setError('Setting Description: '.db_error());
414 // Saving the followups value.
415 $res=db_query_params ('INSERT INTO artifact_query_fields
416 (artifact_query_id,query_field_type,query_field_id,query_field_values)
417 VALUES ($1,$2,$3,$4)',
419 ARTIFACT_QUERY_FOLLOWUPS,
423 $this->setError('Setting Followups: '.db_error());
427 if (!$extra_fields) {
428 $extra_fields=array();
431 $keys=array_keys($extra_fields);
432 $vals=array_values($extra_fields);
433 for ($i=0; $i<count($keys); $i++) {
438 // Checkboxes and multi-select may be arrays so store it comma-separated
440 if (is_array($vals[$i])) {
441 for($e=0; $e<count($vals[$i]); $e++) {
442 $vals[$i][$e]=intval($vals[$i][$e]);
444 $vals[$i]=implode(',',$vals[$i]);
447 $aef = new ArtifactExtraField($this->ArtifactType, $keys[$i]);
448 $type = $aef->getType();
449 if ($type == ARTIFACT_EXTRAFIELDTYPE_INTEGER) {
450 if (!preg_match('/^[><= \-\+0-9%]+$/', $vals[$i])) {
451 $this->setError('Invalid Value for Integer type: '. $vals[$i]);
456 $res = db_query_params ('INSERT INTO artifact_query_fields
457 (artifact_query_id,query_field_type,query_field_id,query_field_values)
458 VALUES ($1,$2,$3,$4)',
460 ARTIFACT_QUERY_EXTRAFIELD,
464 $this->setError('Setting values: '.db_error());
472 * getID - get this ArtifactQuery ID.
474 * @return int The id #.
477 return $this->data_array['artifact_query_id'];
481 * getName - get the name.
483 * @return string The name.
486 return $this->data_array['query_name'];
490 * getUserId - get the user_id.
492 * @return string The user_id.
494 function getUserId() {
495 return $this->data_array['user_id'];
499 * getQueryType - get the type of the query
501 * @return string type of query (0: private, 1: project, 2: project&default)
503 function getQueryType() {
504 return $this->data_array['query_type'];
508 * getQueryOptions - get the options of the query
510 * @return array array of all activated options
512 function getQueryOptions() {
513 if (isset($this->data_array['query_options'])) {
514 return explode('|', $this->data_array['query_options']);
521 * getSortCol - the column that you're sorting on
523 * @return string The column name.
525 function getSortCol() {
526 if (!isset($this->element_array))
528 return $this->element_array[ARTIFACT_QUERY_SORTCOL][0];
532 * getSortOrd - ASC or DESC
534 * @return string ASC or DESC
536 function getSortOrd() {
537 if (!isset($this->element_array))
539 return $this->element_array[ARTIFACT_QUERY_SORTORD][0];
543 * getModDateRange - get the range of dates to include in a query
545 * @return string mod date range.
547 function getModDateRange() {
548 if (!isset($this->element_array))
550 if ($this->element_array[ARTIFACT_QUERY_MODDATE][0]) {
551 return $this->element_array[ARTIFACT_QUERY_MODDATE][0];
558 * getOpenDateRange - get the range of dates to include in a query
560 * @return string Open date range.
562 function getOpenDateRange() {
563 if (!isset($this->element_array))
565 if ($this->element_array[ARTIFACT_QUERY_OPENDATE][0]) {
566 return $this->element_array[ARTIFACT_QUERY_OPENDATE][0];
573 * getCloseDateRange - get the range of dates to include in a query
575 * @return string Close date range.
577 function getCloseDateRange() {
578 if (!isset($this->element_array))
580 if ($this->element_array[ARTIFACT_QUERY_CLOSEDATE][0]) {
581 return $this->element_array[ARTIFACT_QUERY_CLOSEDATE][0];
588 * getSummary - get the summary string to include in a query
590 * @return string Summary string.
592 function getSummary() {
593 if (!isset($this->element_array[ARTIFACT_QUERY_SUMMARY][0])) {
596 return $this->element_array[ARTIFACT_QUERY_SUMMARY][0];
600 * getDescription - get the description string to include in a query
602 * @return string Description string.
604 function getDescription() {
605 if (!isset($this->element_array[ARTIFACT_QUERY_DESCRIPTION][0])) {
608 return $this->element_array[ARTIFACT_QUERY_DESCRIPTION][0];
612 * getFollowups - get the followups string to include in a query
614 * @return string Folowups string.
616 function getFollowups() {
617 if (!isset($this->element_array[ARTIFACT_QUERY_FOLLOWUPS][0])) {
620 return $this->element_array[ARTIFACT_QUERY_FOLLOWUPS][0];
626 * @return string Assignee ID
628 function getAssignee() {
629 if (!isset($this->element_array[ARTIFACT_QUERY_ASSIGNEE]))
631 return $this->element_array[ARTIFACT_QUERY_ASSIGNEE][0];
637 * @return string Submitter ID
639 function getSubmitter() {
640 if (!isset($this->element_array[ARTIFACT_QUERY_SUBMITTER]))
642 return $this->element_array[ARTIFACT_QUERY_SUBMITTER][0];
648 * @return string Status ID
650 function getStatus() {
651 if (!isset($this->element_array))
653 return $this->element_array[ARTIFACT_QUERY_STATE][0];
657 * getExtraFields - complex multi-dimensional array of extra field IDs/Vals
659 * @return array Complex Array
661 function getExtraFields() {
662 if (!isset($this->element_array))
664 if (! isset ($this->element_array[ARTIFACT_QUERY_EXTRAFIELD])) {
665 $this->element_array[ARTIFACT_QUERY_EXTRAFIELD] = array () ;
667 return $this->element_array[ARTIFACT_QUERY_EXTRAFIELD];
671 * validateDateRange - validate a date range in this format '1999-05-01 1999-06-01'.
673 * @return boolean true/false.
675 function validateDateRange($daterange) {
676 return preg_match('/[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{4}-[0-9]{2}-[0-9]{2}/',$daterange);
680 * update - update a row in the table used to query names
683 * @param int Id of the saved query
684 * @param string The name of the saved query
685 * @return boolean success.
687 function update($name,$status,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange='',$closedaterange='',
688 $summary,$description,$followups,$query_type=0,$query_options=array(),$submitter='') {
690 $this->setMissingParamsError();
693 if (!session_loggedin()) {
694 $this->setError('Must Be Logged In');
697 if (!$this->Exist(htmlspecialchars($name))) {
698 $this->setError(_('Query does not exist'));
701 if ($query_type>0 && !forge_check_perm ('tracker', $this->ArtifactType->getID(), 'manager')) {
702 $this->setError(_('You must have tracker admin rights to set or update a project level query.'));
706 // Reset the project default query.
707 if ($query_type==2) {
708 $res = db_query_params ('UPDATE artifact_query SET query_type=1 WHERE query_type=2 AND group_artifact_id=$1',
709 array($this->ArtifactType->getID()));
711 $this->setError('Error Updating: '.db_error());
716 $result = db_query_params ('UPDATE artifact_query
720 WHERE artifact_query_id=$4',
721 array (htmlspecialchars($name),
723 join('|', $query_options),
725 if ($result && db_affected_rows($result) > 0) {
726 if (!$this->insertElements($this->getID(),$status,$submitter,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange,$closedaterange,$summary,$description,$followups)) {
731 $this->fetchData($this->getID());
735 $this->setError('Error Updating: '.db_error());
742 * makeDefault - set this as the default query
744 * @return boolean success.
746 function makeDefault() {
747 if (!session_loggedin()) {
748 $this->setError('Must Be Logged In');
751 $usr =& session_get_user();
752 return $usr->setPreference('art_query'.$this->ArtifactType->getID(),$this->getID());
756 * delete - delete query
758 * @return boolean success.
761 if (forge_check_perm ('tracker', $this->ArtifactType->getID(), 'manager')) {
762 $res = db_query_params ('DELETE FROM artifact_query WHERE artifact_query_id=$1 AND (user_id=$2 OR query_type>0)',
763 array ($this->getID(),
769 $res = db_query_params ('DELETE FROM artifact_query WHERE artifact_query_id=$1 AND user_id=$2',
770 array ($this->getID(),
776 $res = db_query_params ('DELETE FROM user_preferences WHERE preference_value=$1 AND preference_name =$2',
777 array ($this->getID(),
778 'art_query'.$this->ArtifactType->getID())) ;
779 unset($this->data_array);
780 unset($this->element_array);
785 * Exist - check if already exist a query with the same name , user_id and artifact_id
787 * @return boolean exist
789 function Exist($name) {
790 $user_id = user_getid();
791 $art_id = $this->ArtifactType->getID();
792 $res = db_query_params ('SELECT * FROM artifact_query WHERE group_artifact_id = $1 AND query_name = $2 AND (user_id = $3 OR query_type>0)',
796 if (db_numrows($res)>0) {
806 // c-file-style: "bsd"