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
121 * @param string $name
124 * @param $moddaterange
127 * @param $extra_fields
128 * @param int $opendaterange
129 * @param int $closedaterange
130 * @param string $summary
131 * @param string $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;
249 * insertElements - ???
255 * @param $moddaterange
258 * @param $extra_fields
259 * @param $opendaterange
260 * @param $closedaterange
261 * @param string $summary
262 * @param string $description
264 * @return boolean True/false on success or not.
266 function insertElements($id,$status,$submitter,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange,$closedaterange,$summary,$description,$followups) {
267 $res = db_query_params ('DELETE FROM artifact_query_fields WHERE artifact_query_id=$1',
270 $this->setError('Deleting Old Elements: '.db_error());
274 $status = intval($status);
275 $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)',
277 ARTIFACT_QUERY_STATE,
280 $this->setError('Setting Status: '.db_error());
284 if (is_array($submitter)) {
285 for($e=0; $e<count($submitter); $e++) {
286 $submitter[$e]=intval($submitter[$e]);
288 $submitter=implode(',',$submitter);
290 $submitter = intval($submitter);
293 if (is_array($assignee)) {
294 for($e=0; $e<count($assignee); $e++) {
295 $assignee[$e]=intval($assignee[$e]);
297 $assignee=implode(',',$assignee);
299 $assignee = intval($assignee);
302 if (preg_match("/[^[:alnum:]_]/", $sort_col)) {
303 $this->setError('ArtifactQuery: not valid sort_col');
307 if (preg_match("/[^[:alnum:]_]/", $sort_ord)) {
308 $this->setError('ArtifactQuery: not valid sort_ord');
312 //CSV LIST OF SUBMITTERS
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_SUBMITTER,
321 $this->setError('Setting Submitter: '.db_error());
326 //CSV LIST OF ASSIGNEES
328 $res = db_query_params ('INSERT INTO artifact_query_fields
329 (artifact_query_id,query_field_type,query_field_id,query_field_values)
330 VALUES ($1,$2,0,$3)',
332 ARTIFACT_QUERY_ASSIGNEE,
335 $this->setError('Setting Assignee: '.db_error());
340 //MOD DATE RANGE YYYY-MM-DD YYYY-MM-DD format
341 if ($moddaterange && !$this->validateDateRange($moddaterange)) {
342 $this->setError(_('Invalid Last Modified Date Range'));
345 $res = db_query_params ('INSERT INTO artifact_query_fields
346 (artifact_query_id,query_field_type,query_field_id,query_field_values)
347 VALUES ($1,$2,0,$3)',
349 ARTIFACT_QUERY_MODDATE,
352 $this->setError('Setting Last Modified Date Range: '.db_error());
356 //OPEN DATE RANGE YYYY-MM-DD YYYY-MM-DD format
357 if ($opendaterange && !$this->validateDateRange($opendaterange)) {
358 $this->setError(_('Invalid Open Date Range'));
361 $res = db_query_params ('INSERT INTO artifact_query_fields
362 (artifact_query_id,query_field_type,query_field_id,query_field_values)
363 VALUES ($1,$2,0,$3)',
365 ARTIFACT_QUERY_OPENDATE,
368 $this->setError('Setting Open Date Range: '.db_error());
372 //CLOSE DATE RANGE YYYY-MM-DD YYYY-MM-DD format
373 if ($closedaterange && !$this->validateDateRange($closedaterange)) {
374 $this->setError(_('Invalid Close Date Range'));
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_CLOSEDATE,
384 $this->setError('Setting Close Date Range: '.db_error());
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,0,$3)',
393 ARTIFACT_QUERY_SORTCOL,
396 $this->setError('Setting Sort Col: '.db_error());
399 $res = db_query_params ('INSERT INTO artifact_query_fields
400 (artifact_query_id,query_field_type,query_field_id,query_field_values)
401 VALUES ($1,$2,0,$3)',
403 ARTIFACT_QUERY_SORTORD,
406 $this->setError('Setting Sort Order: '.db_error());
410 // Saving the summary value.
411 $res=db_query_params ('INSERT INTO artifact_query_fields
412 (artifact_query_id,query_field_type,query_field_id,query_field_values)
413 VALUES ($1,$2,$3,$4)',
415 ARTIFACT_QUERY_SUMMARY,
419 $this->setError('Setting Summary: '.db_error());
423 // Saving the description value.
424 $res=db_query_params ('INSERT INTO artifact_query_fields
425 (artifact_query_id,query_field_type,query_field_id,query_field_values)
426 VALUES ($1,$2,$3,$4)',
428 ARTIFACT_QUERY_DESCRIPTION,
432 $this->setError('Setting Description: '.db_error());
436 // Saving the followups value.
437 $res=db_query_params ('INSERT INTO artifact_query_fields
438 (artifact_query_id,query_field_type,query_field_id,query_field_values)
439 VALUES ($1,$2,$3,$4)',
441 ARTIFACT_QUERY_FOLLOWUPS,
445 $this->setError('Setting Followups: '.db_error());
449 if (!$extra_fields) {
450 $extra_fields=array();
453 $keys=array_keys($extra_fields);
454 $vals=array_values($extra_fields);
455 for ($i=0; $i<count($keys); $i++) {
460 // Checkboxes and multi-select may be arrays so store it comma-separated
462 if (is_array($vals[$i])) {
463 for($e=0; $e<count($vals[$i]); $e++) {
464 $vals[$i][$e]=intval($vals[$i][$e]);
466 $vals[$i]=implode(',',$vals[$i]);
469 $aef = new ArtifactExtraField($this->ArtifactType, $keys[$i]);
470 $type = $aef->getType();
471 if ($type == ARTIFACT_EXTRAFIELDTYPE_INTEGER) {
472 if (!preg_match('/^[><= \-\+0-9%]+$/', $vals[$i])) {
473 $this->setError('Invalid Value for Integer type: '. $vals[$i]);
478 $res = db_query_params ('INSERT INTO artifact_query_fields
479 (artifact_query_id,query_field_type,query_field_id,query_field_values)
480 VALUES ($1,$2,$3,$4)',
482 ARTIFACT_QUERY_EXTRAFIELD,
486 $this->setError('Setting values: '.db_error());
494 * getID - get this ArtifactQuery ID.
496 * @return int The id #.
499 return $this->data_array['artifact_query_id'];
503 * getName - get the name.
505 * @return string The name.
508 return $this->data_array['query_name'];
512 * getUserId - get the user_id.
514 * @return string The user_id.
516 function getUserId() {
517 return $this->data_array['user_id'];
521 * getQueryType - get the type of the query
523 * @return string type of query (0: private, 1: project, 2: project&default)
525 function getQueryType() {
526 return $this->data_array['query_type'];
530 * getQueryOptions - get the options of the query
532 * @return array array of all activated options
534 function getQueryOptions() {
535 if (isset($this->data_array['query_options'])) {
536 return explode('|', $this->data_array['query_options']);
543 * getSortCol - the column that you're sorting on
545 * @return string The column name.
547 function getSortCol() {
548 if (!isset($this->element_array))
550 return $this->element_array[ARTIFACT_QUERY_SORTCOL][0];
554 * getSortOrd - ASC or DESC
556 * @return string ASC or DESC
558 function getSortOrd() {
559 if (!isset($this->element_array))
561 return $this->element_array[ARTIFACT_QUERY_SORTORD][0];
565 * getModDateRange - get the range of dates to include in a query
567 * @return string mod date range.
569 function getModDateRange() {
570 if (!isset($this->element_array))
572 if ($this->element_array[ARTIFACT_QUERY_MODDATE][0]) {
573 return $this->element_array[ARTIFACT_QUERY_MODDATE][0];
580 * getOpenDateRange - get the range of dates to include in a query
582 * @return string Open date range.
584 function getOpenDateRange() {
585 if (!isset($this->element_array))
587 if (isset($this->element_array[ARTIFACT_QUERY_OPENDATE][0])) {
588 return $this->element_array[ARTIFACT_QUERY_OPENDATE][0];
595 * getCloseDateRange - get the range of dates to include in a query
597 * @return string Close date range.
599 function getCloseDateRange() {
600 if (!isset($this->element_array))
602 if (isset($this->element_array[ARTIFACT_QUERY_CLOSEDATE][0])) {
603 return $this->element_array[ARTIFACT_QUERY_CLOSEDATE][0];
610 * getSummary - get the summary string to include in a query
612 * @return string Summary string.
614 function getSummary() {
615 if (!isset($this->element_array[ARTIFACT_QUERY_SUMMARY][0])) {
618 return $this->element_array[ARTIFACT_QUERY_SUMMARY][0];
622 * getDescription - get the description string to include in a query
624 * @return string Description string.
626 function getDescription() {
627 if (!isset($this->element_array[ARTIFACT_QUERY_DESCRIPTION][0])) {
630 return $this->element_array[ARTIFACT_QUERY_DESCRIPTION][0];
634 * getFollowups - get the followups string to include in a query
636 * @return string Folowups string.
638 function getFollowups() {
639 if (!isset($this->element_array[ARTIFACT_QUERY_FOLLOWUPS][0])) {
642 return $this->element_array[ARTIFACT_QUERY_FOLLOWUPS][0];
648 * @return string Assignee ID
650 function getAssignee() {
651 if (!isset($this->element_array[ARTIFACT_QUERY_ASSIGNEE]))
653 return $this->element_array[ARTIFACT_QUERY_ASSIGNEE][0];
659 * @return string Submitter ID
661 function getSubmitter() {
662 if (!isset($this->element_array[ARTIFACT_QUERY_SUBMITTER]))
664 return $this->element_array[ARTIFACT_QUERY_SUBMITTER][0];
670 * @return string Status ID
672 function getStatus() {
673 if (!isset($this->element_array))
675 return $this->element_array[ARTIFACT_QUERY_STATE][0];
679 * getExtraFields - complex multi-dimensional array of extra field IDs/Vals
681 * @return array Complex Array
683 function getExtraFields() {
684 if (!isset($this->element_array))
686 if (! isset ($this->element_array[ARTIFACT_QUERY_EXTRAFIELD])) {
687 $this->element_array[ARTIFACT_QUERY_EXTRAFIELD] = array () ;
689 return $this->element_array[ARTIFACT_QUERY_EXTRAFIELD];
693 * validateDateRange - validate a date range in this format '1999-05-01 1999-06-01'.
695 * @param string $daterange A range of two dates (1999-05-01 1999-06-01)
696 * @return bool true/false.
698 function validateDateRange(&$daterange) {
699 if(! preg_match('/([0-9]{4})-[0-9]{2}-[0-9]{2} ([0-9]{4})-[0-9]{2}-[0-9]{2}/', $daterange, $matches)) {
703 # Hack to avoid exceeding the maximum value for an integer in the database
704 if ($matches[1] > 2037) {
705 $daterange = preg_replace('/[\d]{4}(-[\d]{2}-[\d]{2} [\d]{4}-[\d]{2}-[\d]{2})/', '2037$1', $daterange);
707 if ($matches[2] > 2037) {
708 $daterange = preg_replace('/([\d]{4}-[\d]{2}-[\d]{2} )[\d]{4}(-[\d]{2}-[\d]{2})/', '${1}2037$2', $daterange);
715 * update - update a row in the table used to query names
721 * @param $moddaterange
724 * @param $extra_fields
725 * @param string $opendaterange
726 * @param string $closedaterange
728 * @param $description
730 * @param int $query_type Id of the saved query
731 * @param array $query_options
732 * @param string $submitter
733 * @return bool success.
735 function update($name,$status,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange='',$closedaterange='',
736 $summary,$description,$followups,$query_type=0,$query_options=array(),$submitter='') {
738 $this->setMissingParamsError();
741 if (!session_loggedin()) {
742 $this->setError(_('Must Be Logged In'));
745 if (!$this->Exist(htmlspecialchars($name))) {
746 $this->setError(_('Query does not exist'));
749 if ($query_type>0 && !forge_check_perm ('tracker', $this->ArtifactType->getID(), 'manager')) {
750 $this->setError(_('You must have tracker admin rights to set or update a project level query.'));
754 // Reset the project default query.
755 if ($query_type==2) {
756 $res = db_query_params ('UPDATE artifact_query SET query_type=1 WHERE query_type=2 AND group_artifact_id=$1',
757 array($this->ArtifactType->getID()));
759 $this->setError('Error Updating: '.db_error());
764 $result = db_query_params ('UPDATE artifact_query
768 WHERE artifact_query_id=$4',
769 array (htmlspecialchars($name),
771 join('|', $query_options),
773 if ($result && db_affected_rows($result) > 0) {
774 if (!$this->insertElements($this->getID(),$status,$submitter,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange,$closedaterange,$summary,$description,$followups)) {
779 $this->fetchData($this->getID());
783 $this->setError('Error Updating: '.db_error());
790 * makeDefault - set this as the default query
792 * @return boolean success.
794 function makeDefault() {
795 if (!session_loggedin()) {
796 $this->setError(_('Must Be Logged In'));
799 $usr =& session_get_user();
800 return $usr->setPreference('art_query'.$this->ArtifactType->getID(),$this->getID());
804 * delete - delete query
806 * @return boolean success.
809 if (forge_check_perm ('tracker', $this->ArtifactType->getID(), 'manager')) {
810 $res = db_query_params ('DELETE FROM artifact_query WHERE artifact_query_id=$1 AND (user_id=$2 OR query_type>0)',
811 array ($this->getID(),
817 $res = db_query_params ('DELETE FROM artifact_query WHERE artifact_query_id=$1 AND user_id=$2',
818 array ($this->getID(),
824 db_query_params ('DELETE FROM user_preferences WHERE preference_value=$1 AND preference_name =$2',
825 array ($this->getID(),
826 'art_query'.$this->ArtifactType->getID())) ;
827 unset($this->data_array);
828 unset($this->element_array);
833 * Exist - check if already exist a query with the same name , user_id and artifact_id
835 * @param string $name Name of query
836 * @return bool true if query already exists
838 function Exist($name) {
839 $user_id = user_getid();
840 $art_id = $this->ArtifactType->getID();
841 $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)',
845 if (db_numrows($res)>0) {
855 // c-file-style: "bsd"