/usr/share/horde/nag/lib/Search.php is in php-horde-nag 4.1.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?php
/**
* Copyright 2001-2013 Horde LLC (http://www.horde.org/)
*
* See the enclosed file LICENSE for license information (BSD). If you did not
* did not receive this file, see http://www.horde.org/licenses/bsdl.php.
*
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/gpl GPL
* @package Nag
*/
/**
* Nag_Search:: Interface for performing task searches.
*
* Copyright 2001-2013 Horde LLC (http://www.horde.org/)
*
* See the enclosed file LICENSE for license information (BSD). If you did not
* did not receive this file, see http://www.horde.org/licenses/bsdl.php.
*
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @category Horde
* @license http://www.horde.org/licenses/gpl GPL
* @package Nag
*/
class Nag_Search implements Serializable
{
/**
* Search bit masks
*/
const MASK_NAME = 1;
const MASK_DESC = 2;
const MASK_TAGS = 4;
const MASK_ALL = 7;
/**
* Search criteria
*
* @var array
*/
protected $_search;
/**
* The search mask
*
* @var integer
*/
protected $_mask;
/**
* The completed/view value.
*
* @var integer
*/
protected $_completed;
/**
* The tasks lists to search.
*
* @var array
*/
protected $_tasklists;
/**
* Duedate criteria
*
* @var array
*/
protected $_due;
/**
* Tag search criteria
*
* @var array
*/
protected $_tags;
/**
* Constructor
*
* @param string $search The search string.
* @param integer $mask A bitmask to indicate the fields to search.
* @param array $options Additional options:
* - completed: (integer) Which tasks to include. A NAG::VIEW_* constant.
* DEFAULT: Nag::VIEW_INCOMPLETE
*
* - due: (array) An array describing the due date portion of the search.
* EXAMPLE: array('5', 'tomorrow') would be all tasks due within 5
* days of tomorrow.
* DEFAULT: No date filters.
*
* - tags: (array) An array of tags to filter on.
* - tasklists: (array) An array of tasklist ids to filter on.
* DEFAULT: The current display_tasklists value is used.
*
* @return Nag_Search
*/
public function __construct($search, $mask, array $options = array())
{
$options = array_merge(
array(
'completed' => 0,
'due' => array(),
'tags' => array(),
'tasklists' => $GLOBALS['display_tasklists']),
$options);
$this->_search = $search;
$this->_mask = $mask;
$this->_completed = $options['completed'];
$this->_due = $options['due'];
$this->_tags = $options['tags'];
$this->_tasklists = $options['tasklists'];
}
/**
* Get a result slice.
*
* @param integer $page The page number
* @param integer $perpage The number of results per page.
*
* @return Nag_Task The result list.
*/
public function getSlice($page = 0, $perpage = 0)
{
return $this->_search($page, $perpage);
}
/**
* Perform the search
*
* @param integer $page The page number
* @param integer $perpage The number of results per page.
*
* @return Nag_Task
*/
protected function _search($page, $perpage)
{
global $injector, $prefs;
if (!empty($this->_due)) {
$parser = Horde_Date_Parser::factory(array('locale' => $GLOBALS['prefs']->getValue('language')));
$date = $parser->parse($this->_due[1]);
$date->mday += $this->_due[0];
$date = $date->timestamp();
} else {
$date = false;
}
// Get the full, sorted task list.
$tasks = Nag::listTasks(array(
'tasklists' => $this->_tasklists,
'completed' => $this->_completed,
'include_history' => false)
);
if (!empty($this->_search)) {
$pattern = '/' . preg_quote($this->_search, '/') . '/i';
}
$search_results = new Nag_Task();
if (!empty($this->_tags)) {
$tagged_tasks = $injector->getInstance('Nag_Tagger')->search(
$this->_tags,
array('list' => $GLOBALS['display_tasklists'])
);
}
$tasks->reset();
while ($task = $tasks->each()) {
if (!empty($date)) {
if (empty($task->due) || $task->due > $date) {
continue;
}
}
// If we have a search string and it doesn't match name|desc continue
if (!empty($this->_search) &&
!($this->_mask & self::MASK_NAME && preg_match($pattern, $task->name)) &&
!($this->_mask & self::MASK_DESC && preg_match($pattern, $task->desc))) {
continue;
}
// No tags to search? Add it to results. Otherwise, make sure it
// has the requested tags.
if (empty($this->_tags) || in_array($task->uid, $tagged_tasks)) {
$search_results->add($task);
}
}
// Now that we have filtered results, load all tags at once.
$search_results->loadTags();
return $search_results;
}
/**
* Populate a Horde_Variables instance with the search values for this
* search.
*
* @param Horde_Variables $vars The Horde_Variables object.
*/
public function getVars(Horde_Variables &$vars)
{
$vars->set('search_pattern', $this->_search);
$vars->set('search_tags', implode(',', $this->_tags));
$vars->set('search_completed', $this->_completed);
$vars->set('due_within', $this->_due[0]);
$vars->set('due_of', $this->_due[1]);
$mask = array();
if ($this->_mask & self::MASK_NAME) {
$mask[] = 'search_name';
}
if ($this->_mask & self::MASK_DESC) {
$mask[] = 'search_desc';
}
if (!empty($mask)) {
$vars->set('search_in', $mask);
}
}
/**
* Serialize method
*
* @return array The unserialized data.
*/
public function serialize()
{
return serialize(array(
'search' => $this->_search,
'mask' => $this->_mask,
'completed' => $this->_completed,
'due' => $this->_due,
'tags' => $this->_tags));
}
/**
* Unserialize method
*
* @param string $data The serialized data.
*/
public function unserialize($data)
{
$data = unserialize($data);
$this->_search = $data['search'];
$this->_mask = $data['mask'];
$this->_completed = $data['completed'];
$this->_due = $data['due'];
$this->_tags = $data['tags'];
}
}
|