/usr/share/horde/wicked/lib/Driver.php is in php-horde-wicked 2.0.7-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 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 | <?php
/**
* Copyright 2003-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (GPL). If you
* did not receive this file, see http://www.horde.org/licenses/gpl.
*
* @category Horde
* @license http://www.horde.org/licenses/gpl GPL
* @author Tyler Colbert <tyler@colberts.us>
* @package Wicked
*/
/**
* Wicked_Driver defines an API for implementing storage backends for Wicked.
*
* @category Horde
* @license http://www.horde.org/licenses/gpl GPL
* @author Tyler Colbert <tyler@colberts.us>
* @package Wicked
*/
abstract class Wicked_Driver
{
/**
* Hash containing connection parameters.
*
* @var array
*/
protected $_params = array();
/**
* VFS object for storing attachments.
*
* @var VFS
*/
protected $_vfs;
/**
* Constructor.
*
* @param array $params A hash containing connection parameters.
*/
public function __construct($params = array())
{
$this->_params = $params;
}
/**
* Accessor to manage a VFS instance.
*
* @throws Wicked_Exception
*/
public function getVFS()
{
if (!$this->_vfs) {
try {
$this->_vfs = $GLOBALS['injector']->getInstance('Horde_Core_Factory_Vfs')->create();
} catch (Horde_Vfs_Exception $e) {
throw new Wicked_Exception($e);
}
}
return $this->_vfs;
}
/**
* Retrieves the page of a particular name from the database.
*
* @param string $pagename The name of the page to retrieve
*
*/
abstract function retrieveByName($pagename);
/**
* Retrieves a historic version of a page.
*
* @param string $pagename The name of the page to retrieve.
* @param string $version The version to retrieve.
*
*/
abstract function retrieveHistory($pagename, $version);
/**
* Logs a hit to $pagename.
*
* @param string $pagename The page that was viewed.
*/
abstract function logPageView($pagename);
/**
* Creates a new page.
*
* @param string $pagename The new page's name.
* @param string $text The new page's text.
*/
abstract function newPage($pagename, $text);
abstract function updateText($pagename, $text, $changelog);
abstract function renamePage($pagename, $newname);
public function getPageId($pagename)
{
$pages = $this->getPages();
$ids = array_flip($pages);
return isset($ids[$pagename]) ? $ids[$pagename] : false;
}
public function getPage($pagename)
{
return array();
}
public function getPageById($id)
{
return array();
}
public function getSpecialPages()
{
static $pages;
if (isset($pages)) {
return $pages;
}
$dh = opendir(WICKED_BASE . '/lib/Page');
$pages = array();
while (($dent = readdir($dh)) !== false) {
if (!preg_match('/(.*)\.php$/', $dent, $matches)) {
continue;
}
$pageName = $matches[1];
if ($pageName == 'StandardPage') {
continue;
}
$pages[$pageName] = $pageName;
}
closedir($dh);
return $pages;
}
public function getPages($special = true)
{
return array();
}
public function pageExists($pagename)
{
return in_array($pagename, $this->getPages());
}
abstract function getAllPages();
abstract function getHistory($pagename);
/**
* Returns the most recently changed pages.
*
* @param integer $days The number of days to look back.
*
* @return array Pages.
*/
abstract function getRecentChanges($days = 3);
/**
* Returns the most recently changed pages.
*
* @param integer $limit The number of most recent pages to return.
*
* @return array Pages.
*/
abstract function mostRecent($limit = 10);
/**
* Returns the most popular pages.
*
* @param integer $limit The number of most popular pages to return.
*
* @return array Pages.
*/
abstract function mostPopular($limit = 10);
/**
* Returns the least popular pages.
*
* @param integer $limit The number of least popular pages to return.
*
* @return array Pages.
*/
abstract function leastPopular($limit = 10);
/**
* Finds pages with matches in text or title.
*
* @param string $searchtext The search expression (Google-like).
*
* @return array A list of pages
*/
abstract function searchText($searchtext);
abstract function getBackLinks($pagename);
abstract function getLikePages($pagename);
/**
* Retrieves data on files attached to a page.
*
* @param string $pageId This is the Id of the page for which we'd
* like to find attached files.
* @param boolean $allversions Whether to include all versions. If false
* or omitted, only the most recent version
* of each attachment is returned.
* @return array An array of key/value arrays describing the attached
* files.
*/
abstract function getAttachedFiles($pageId, $allversions = false);
/**
* Attaches a file to a page or update an attachment.
*
* @param array $file This is a key/value array describing the
* attachment:<pre>
* 'page_id' => This is the id of the page to which we would
* like to attach the file.
* 'attachment_name' => This is the filename of the attachment.
* 'change_log' => A change log entry for this attach or update
* operation. (Optional)
* 'change_author' => The user uploading this file. If not present,
* the currently logged-in user is assumed.</pre>
* @param string $data This is the contents of the file to be attached.
*
* @throws Wicked_Exception
*/
public function attachFile($file, $data)
{
$vfs = $this->getVFS();
if (!isset($file['change_author'])) {
$file['change_author'] = $GLOBALS['registry']->getAuth();
}
$result = $this->_attachFile($file);
/* We encode the path quoted printable so we won't get any nasty
* characters the filesystem might reject. */
$path = Wicked::VFS_ATTACH_PATH . '/' . $file['page_id'];
try {
$vfs->writeData($path, $file['attachment_name'] . ';' . $result, $data, true);
} catch (Horde_Vfs_Exception $e) {
throw new Wicked_Exception($e);
}
}
/**
* Remove a single version or all versions of an attachment to
* $pageId from the VFS backend.
*
* @param integer $pageId The Id of the page the file is attached to.
* @param string $attachment The name of the file.
* @param string $version If specified, the version to delete. If null,
* then all versions of $attachment will be removed.
*
* @throws Wicked_Exception
*/
public function removeAttachment($pageId, $attachment, $version = null)
{
$vfs = $this->getVFS();
$path = Wicked::VFS_ATTACH_PATH . '/' . $pageId;
$fileList = $this->getAttachedFiles($pageId, true);
foreach ($fileList as $file) {
$fileversion = $file['attachment_version'];
if ($file['attachment_name'] == $attachment &&
(is_null($version) || $fileversion == $version)) {
/* Skip any attachments that don't exist so they can
* be cleared out of the backend. */
if (!$vfs->exists($path, $attachment . ';' . $fileversion)) {
continue;
}
try {
$vfs->deleteFile($path, $attachment . ';' . $fileversion);
} catch (Horde_Vfs_Exception $e) {
throw new Wicked_Exception($e);
}
}
}
}
/**
* Removes all attachments to $pageId from the VFS backend.
*
* @param integer $pageId The Id of the page to remove attachments from.
*
* @throws Wicked_Exception
*/
public function removeAllAttachments($pageId)
{
if (empty($pageId)) {
throw new Wicked_Exception('Cannot delete all attachments of all pages at once');
}
$vfs = $this->getVFS();
if (!$vfs->isFolder(Wicked::VFS_ATTACH_PATH, $pageId)) {
return;
}
try {
$vfs->deleteFolder(Wicked::VFS_ATTACH_PATH, $pageId, true);
} catch (Horde_Vfs_Exception $e) {
throw new Wicked_Exception($e);
}
}
/**
* Handles the driver-specific portion of attaching a file.
*
* Wicked_Driver::attachFile() calls down to this method for the driver-
* specific portion, and then uses VFS to store the attachment.
*
* @param array $file See Wicked_Driver::attachFile().
*
* @return boolean The new version of the file attached
* @throws Wicked_Exception
*/
abstract protected function _attachFile($file);
/**
* Retrieves the contents of an attachment.
*
* @param string $pageId This is the name of the page to which the file
* is attached.
* @param string $filename This is the name of the attachment.
* @param string $version This is the version of the attachment.
*
* @return string The file's contents.
* @throws Wicked_Exception
*/
public function getAttachmentContents($pageId, $filename, $version)
{
$vfs = $this->getVFS();
$path = Wicked::VFS_ATTACH_PATH . '/' . $pageId;
try {
return $vfs->read($path, $filename . ';' . $version);
} catch (Horde_Vfs_Exception $e) {
throw new Wicked_Exception($e);
}
}
abstract function removeVersion($pagename, $version);
public function removeAllVersions($pagename)
{
/* When deleting a page, also delete all its attachments. */
$this->removeAllAttachments($this->getPageId($pagename));
}
abstract function searchTitles($searchtext);
/**
* Returns the charset used by the backend.
*
* @return string The backend's charset
*/
public function getCharset()
{
return 'UTF-8';
}
}
|