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 * __construct - Constructor
90 * @param $ArtifactType $ArtifactType c object.
91 * @param array|bool $data
93 function __construct(&$ArtifactType, $data = false) {
96 // Was ArtifactType legit?
97 if (!$ArtifactType || !is_object($ArtifactType)) {
98 $this->setError('ArtifactQuery: No Valid ArtifactType');
101 // Did ArtifactType have an error?
102 if ($ArtifactType->isError()) {
103 $this->setError('ArtifactQuery: '.$ArtifactType->getErrorMessage());
106 $this->ArtifactType =& $ArtifactType;
109 if (is_array($data)) {
110 $this->data_array =& $data;
112 $this->fetchData($data);
118 * create - create a row in the table that stores a saved query for
124 * @param $moddaterange
127 * @param $extra_fields
128 * @param int $opendaterange
129 * @param int $closedaterange
131 * @param $description
133 * @param int $query_type
134 * @param array $query_options
135 * @param string $submitter Name of the saved query.
136 * @return bool true on success / false on failure.
138 function create($name,$status,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange=0,$closedaterange=0,
139 $summary,$description,$followups,$query_type=0,$query_options=array(),$submitter='') {
144 $this->setMissingParamsError();
147 if (!session_loggedin()) {
148 $this->setError('Must Be Logged In');
152 if ($this->Exist(htmlspecialchars($name))) {
153 $this->setError(_('Query already exists'));
157 if ($query_type>0 && !forge_check_perm ('tracker', $this->ArtifactType->getID(), 'manager')) {
158 $this->setError( _('You must have tracker admin rights to set or update a project level query.'));
162 // Reset the project default query.
163 if ($query_type==2) {
164 $res = db_query_params ('UPDATE artifact_query SET query_type=1 WHERE query_type=2 AND group_artifact_id=$1',
165 array($this->ArtifactType->getID()));
167 $this->setError('Error Updating: '.db_error());
173 $result = db_query_params ('INSERT INTO artifact_query (group_artifact_id,query_name,user_id,query_type) VALUES ($1,$2,$3,$4)',
174 array ($this->ArtifactType->getID(),
175 htmlspecialchars($name),
178 if ($result && db_affected_rows($result) > 0) {
180 $id=db_insertid($result,'artifact_query','artifact_query_id');
182 $this->setError('Error getting id '.db_error());
186 if (!$this->insertElements($id,$status,$submitter,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange,$closedaterange,$summary,$description,$followups)) {
192 $this->setError(db_error());
197 // Now set up our internal data structures
199 if ($this->fetchData($id)) {
209 * fetchData - re-fetch the data for this ArtifactQuery from the database.
211 * @param int $id ID of saved query.
212 * @return boolean success.
214 function fetchData($id) {
215 $res = db_query_params ('SELECT * FROM artifact_query WHERE artifact_query_id=$1',
218 if (!$res || db_numrows($res) < 1) {
219 $this->setError('ArtifactQuery: Invalid ArtifactQuery ID'.db_error());
222 $this->data_array = db_fetch_array($res);
223 db_free_result($res);
224 $res = db_query_params ('SELECT * FROM artifact_query_fields WHERE artifact_query_id=$1',
226 unset($this->element_array);
227 while ($arr = db_fetch_array($res)) {
229 // Some things may have been saved as comma-separated items
231 if (strstr($arr['query_field_values'],',')) {
232 $arr['query_field_values']=explode(',',$arr['query_field_values']);
234 $this->element_array[$arr['query_field_type']][$arr['query_field_id']]=$arr['query_field_values'];
240 * getArtifactType - get the ArtifactType Object this ArtifactExtraField is associated with.
242 * @return object ArtifactType.
244 function &getArtifactType() {
245 return $this->ArtifactType;
252 function insertElements($id,$status,$submitter,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange,$closedaterange,$summary,$description,$followups) {
253 $res = db_query_params ('DELETE FROM artifact_query_fields WHERE artifact_query_id=$1',
256 $this->setError('Deleting Old Elements: '.db_error());
260 $status = intval($status);
261 $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)',
263 ARTIFACT_QUERY_STATE,
266 $this->setError('Setting Status: '.db_error());
270 if (is_array($submitter)) {
271 for($e=0; $e<count($submitter); $e++) {
272 $submitter[$e]=intval($submitter[$e]);
274 $submitter=implode(',',$submitter);
276 $submitter = intval($submitter);
279 if (is_array($assignee)) {
280 for($e=0; $e<count($assignee); $e++) {
281 $assignee[$e]=intval($assignee[$e]);
283 $assignee=implode(',',$assignee);
285 $assignee = intval($assignee);
288 if (preg_match("/[^[:alnum:]_]/", $sort_col)) {
289 $this->setError('ArtifactQuery: not valid sort_col');
293 if (preg_match("/[^[:alnum:]_]/", $sort_ord)) {
294 $this->setError('ArtifactQuery: not valid sort_ord');
298 //CSV LIST OF SUBMITTERS
300 $res = db_query_params ('INSERT INTO artifact_query_fields
301 (artifact_query_id,query_field_type,query_field_id,query_field_values)
302 VALUES ($1,$2,0,$3)',
304 ARTIFACT_QUERY_SUBMITTER,
307 $this->setError('Setting Submitter: '.db_error());
312 //CSV LIST OF ASSIGNEES
314 $res = db_query_params ('INSERT INTO artifact_query_fields
315 (artifact_query_id,query_field_type,query_field_id,query_field_values)
316 VALUES ($1,$2,0,$3)',
318 ARTIFACT_QUERY_ASSIGNEE,
321 $this->setError('Setting Assignee: '.db_error());
326 //MOD DATE RANGE YYYY-MM-DD YYYY-MM-DD format
327 if ($moddaterange && !$this->validateDateRange($moddaterange)) {
328 $this->setError(_('Invalid Last Modified Date Range'));
331 $res = db_query_params ('INSERT INTO artifact_query_fields
332 (artifact_query_id,query_field_type,query_field_id,query_field_values)
333 VALUES ($1,$2,0,$3)',
335 ARTIFACT_QUERY_MODDATE,
338 $this->setError('Setting Last Modified Date Range: '.db_error());
342 //OPEN DATE RANGE YYYY-MM-DD YYYY-MM-DD format
343 if ($opendaterange && !$this->validateDateRange($opendaterange)) {
344 $this->setError(_('Invalid Open Date Range'));
347 $res = db_query_params ('INSERT INTO artifact_query_fields
348 (artifact_query_id,query_field_type,query_field_id,query_field_values)
349 VALUES ($1,$2,0,$3)',
351 ARTIFACT_QUERY_OPENDATE,
354 $this->setError('Setting Open Date Range: '.db_error());
358 //CLOSE DATE RANGE YYYY-MM-DD YYYY-MM-DD format
359 if ($closedaterange && !$this->validateDateRange($closedaterange)) {
360 $this->setError(_('Invalid Close Date Range'));
363 $res = db_query_params ('INSERT INTO artifact_query_fields
364 (artifact_query_id,query_field_type,query_field_id,query_field_values)
365 VALUES ($1,$2,0,$3)',
367 ARTIFACT_QUERY_CLOSEDATE,
370 $this->setError('Setting Close Date Range: '.db_error());
375 $res = db_query_params ('INSERT INTO artifact_query_fields
376 (artifact_query_id,query_field_type,query_field_id,query_field_values)
377 VALUES ($1,$2,0,$3)',
379 ARTIFACT_QUERY_SORTCOL,
382 $this->setError('Setting Sort Col: '.db_error());
385 $res = db_query_params ('INSERT INTO artifact_query_fields
386 (artifact_query_id,query_field_type,query_field_id,query_field_values)
387 VALUES ($1,$2,0,$3)',
389 ARTIFACT_QUERY_SORTORD,
392 $this->setError('Setting Sort Order: '.db_error());
396 // Saving the summary value.
397 $res=db_query_params ('INSERT INTO artifact_query_fields
398 (artifact_query_id,query_field_type,query_field_id,query_field_values)
399 VALUES ($1,$2,$3,$4)',
401 ARTIFACT_QUERY_SUMMARY,
405 $this->setError('Setting Summary: '.db_error());
409 // Saving the description value.
410 $res=db_query_params ('INSERT INTO artifact_query_fields
411 (artifact_query_id,query_field_type,query_field_id,query_field_values)
412 VALUES ($1,$2,$3,$4)',
414 ARTIFACT_QUERY_DESCRIPTION,
418 $this->setError('Setting Description: '.db_error());
422 // Saving the followups value.
423 $res=db_query_params ('INSERT INTO artifact_query_fields
424 (artifact_query_id,query_field_type,query_field_id,query_field_values)
425 VALUES ($1,$2,$3,$4)',
427 ARTIFACT_QUERY_FOLLOWUPS,
431 $this->setError('Setting Followups: '.db_error());
435 if (!$extra_fields) {
436 $extra_fields=array();
439 $keys=array_keys($extra_fields);
440 $vals=array_values($extra_fields);
441 for ($i=0; $i<count($keys); $i++) {
446 // Checkboxes and multi-select may be arrays so store it comma-separated
448 if (is_array($vals[$i])) {
449 for($e=0; $e<count($vals[$i]); $e++) {
450 $vals[$i][$e]=intval($vals[$i][$e]);
452 $vals[$i]=implode(',',$vals[$i]);
455 $aef = new ArtifactExtraField($this->ArtifactType, $keys[$i]);
456 $type = $aef->getType();
457 if ($type == ARTIFACT_EXTRAFIELDTYPE_INTEGER) {
458 if (!preg_match('/^[><= \-\+0-9%]+$/', $vals[$i])) {
459 $this->setError('Invalid Value for Integer type: '. $vals[$i]);
464 $res = db_query_params ('INSERT INTO artifact_query_fields
465 (artifact_query_id,query_field_type,query_field_id,query_field_values)
466 VALUES ($1,$2,$3,$4)',
468 ARTIFACT_QUERY_EXTRAFIELD,
472 $this->setError('Setting values: '.db_error());
480 * getID - get this ArtifactQuery ID.
482 * @return int The id #.
485 return $this->data_array['artifact_query_id'];
489 * getName - get the name.
491 * @return string The name.
494 return $this->data_array['query_name'];
498 * getUserId - get the user_id.
500 * @return string The user_id.
502 function getUserId() {
503 return $this->data_array['user_id'];
507 * getQueryType - get the type of the query
509 * @return string type of query (0: private, 1: project, 2: project&default)
511 function getQueryType() {
512 return $this->data_array['query_type'];
516 * getQueryOptions - get the options of the query
518 * @return array array of all activated options
520 function getQueryOptions() {
521 if (isset($this->data_array['query_options'])) {
522 return explode('|', $this->data_array['query_options']);
529 * getSortCol - the column that you're sorting on
531 * @return string The column name.
533 function getSortCol() {
534 if (!isset($this->element_array))
536 return $this->element_array[ARTIFACT_QUERY_SORTCOL][0];
540 * getSortOrd - ASC or DESC
542 * @return string ASC or DESC
544 function getSortOrd() {
545 if (!isset($this->element_array))
547 return $this->element_array[ARTIFACT_QUERY_SORTORD][0];
551 * getModDateRange - get the range of dates to include in a query
553 * @return string mod date range.
555 function getModDateRange() {
556 if (!isset($this->element_array))
558 if ($this->element_array[ARTIFACT_QUERY_MODDATE][0]) {
559 return $this->element_array[ARTIFACT_QUERY_MODDATE][0];
566 * getOpenDateRange - get the range of dates to include in a query
568 * @return string Open date range.
570 function getOpenDateRange() {
571 if (!isset($this->element_array))
573 if ($this->element_array[ARTIFACT_QUERY_OPENDATE][0]) {
574 return $this->element_array[ARTIFACT_QUERY_OPENDATE][0];
581 * getCloseDateRange - get the range of dates to include in a query
583 * @return string Close date range.
585 function getCloseDateRange() {
586 if (!isset($this->element_array))
588 if ($this->element_array[ARTIFACT_QUERY_CLOSEDATE][0]) {
589 return $this->element_array[ARTIFACT_QUERY_CLOSEDATE][0];
596 * getSummary - get the summary string to include in a query
598 * @return string Summary string.
600 function getSummary() {
601 if (!isset($this->element_array[ARTIFACT_QUERY_SUMMARY][0])) {
604 return $this->element_array[ARTIFACT_QUERY_SUMMARY][0];
608 * getDescription - get the description string to include in a query
610 * @return string Description string.
612 function getDescription() {
613 if (!isset($this->element_array[ARTIFACT_QUERY_DESCRIPTION][0])) {
616 return $this->element_array[ARTIFACT_QUERY_DESCRIPTION][0];
620 * getFollowups - get the followups string to include in a query
622 * @return string Folowups string.
624 function getFollowups() {
625 if (!isset($this->element_array[ARTIFACT_QUERY_FOLLOWUPS][0])) {
628 return $this->element_array[ARTIFACT_QUERY_FOLLOWUPS][0];
634 * @return string Assignee ID
636 function getAssignee() {
637 if (!isset($this->element_array[ARTIFACT_QUERY_ASSIGNEE]))
639 return $this->element_array[ARTIFACT_QUERY_ASSIGNEE][0];
645 * @return string Submitter ID
647 function getSubmitter() {
648 if (!isset($this->element_array[ARTIFACT_QUERY_SUBMITTER]))
650 return $this->element_array[ARTIFACT_QUERY_SUBMITTER][0];
656 * @return string Status ID
658 function getStatus() {
659 if (!isset($this->element_array))
661 return $this->element_array[ARTIFACT_QUERY_STATE][0];
665 * getExtraFields - complex multi-dimensional array of extra field IDs/Vals
667 * @return array Complex Array
669 function getExtraFields() {
670 if (!isset($this->element_array))
672 if (! isset ($this->element_array[ARTIFACT_QUERY_EXTRAFIELD])) {
673 $this->element_array[ARTIFACT_QUERY_EXTRAFIELD] = array () ;
675 return $this->element_array[ARTIFACT_QUERY_EXTRAFIELD];
679 * validateDateRange - validate a date range in this format '1999-05-01 1999-06-01'.
681 * @param string $daterange A range of two dates (1999-05-01 1999-06-01)
682 * @return bool true/false.
684 function validateDateRange($daterange) {
685 return preg_match('/[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{4}-[0-9]{2}-[0-9]{2}/',$daterange);
689 * update - update a row in the table used to query names
695 * @param $moddaterange
698 * @param $extra_fields
699 * @param string $opendaterange
700 * @param string $closedaterange
702 * @param $description
704 * @param int $query_type Id of the saved query
705 * @param array $query_options
706 * @param string $submitter
707 * @return bool success.
709 function update($name,$status,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange='',$closedaterange='',
710 $summary,$description,$followups,$query_type=0,$query_options=array(),$submitter='') {
712 $this->setMissingParamsError();
715 if (!session_loggedin()) {
716 $this->setError('Must Be Logged In');
719 if (!$this->Exist(htmlspecialchars($name))) {
720 $this->setError(_('Query does not exist'));
723 if ($query_type>0 && !forge_check_perm ('tracker', $this->ArtifactType->getID(), 'manager')) {
724 $this->setError(_('You must have tracker admin rights to set or update a project level query.'));
728 // Reset the project default query.
729 if ($query_type==2) {
730 $res = db_query_params ('UPDATE artifact_query SET query_type=1 WHERE query_type=2 AND group_artifact_id=$1',
731 array($this->ArtifactType->getID()));
733 $this->setError('Error Updating: '.db_error());
738 $result = db_query_params ('UPDATE artifact_query
742 WHERE artifact_query_id=$4',
743 array (htmlspecialchars($name),
745 join('|', $query_options),
747 if ($result && db_affected_rows($result) > 0) {
748 if (!$this->insertElements($this->getID(),$status,$submitter,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange,$closedaterange,$summary,$description,$followups)) {
753 $this->fetchData($this->getID());
757 $this->setError('Error Updating: '.db_error());
764 * makeDefault - set this as the default query
766 * @return boolean success.
768 function makeDefault() {
769 if (!session_loggedin()) {
770 $this->setError('Must Be Logged In');
773 $usr =& session_get_user();
774 return $usr->setPreference('art_query'.$this->ArtifactType->getID(),$this->getID());
778 * delete - delete query
780 * @return boolean success.
783 if (forge_check_perm ('tracker', $this->ArtifactType->getID(), 'manager')) {
784 $res = db_query_params ('DELETE FROM artifact_query WHERE artifact_query_id=$1 AND (user_id=$2 OR query_type>0)',
785 array ($this->getID(),
791 $res = db_query_params ('DELETE FROM artifact_query WHERE artifact_query_id=$1 AND user_id=$2',
792 array ($this->getID(),
798 db_query_params ('DELETE FROM user_preferences WHERE preference_value=$1 AND preference_name =$2',
799 array ($this->getID(),
800 'art_query'.$this->ArtifactType->getID())) ;
801 unset($this->data_array);
802 unset($this->element_array);
807 * Exist - check if already exist a query with the same name , user_id and artifact_id
809 * @param string $name Name of query
810 * @return bool true if query already exists
812 function Exist($name) {
813 $user_id = user_getid();
814 $art_id = $this->ArtifactType->getID();
815 $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)',
819 if (db_numrows($res)>0) {
829 // c-file-style: "bsd"