/usr/share/horde/wicked/lib/Api.php is in php-horde-wicked 2.0.1-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 | <?php
/**
* Copyright 2010-2013 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
* @package Wicked
*/
/**
* Wicked external API interface.
*
* This file defines Wicked's external API interface. Other applications
* can interact with Wicked through this API.
*
* @category Horde
* @license http://www.horde.org/licenses/gpl GPL
* @package Wicked
*/
class Wicked_Api extends Horde_Registry_Api
{
/**
* Links.
*
* @var array
*/
protected $_links = array(
'show' => '%application%/display.php?page=|page|&version=|version|#|toc|'
);
/**
* Returns a list of available pages.
*
* @param boolean $special Include special pages
* @param boolean $no_cache Always retreive pages from backed
*
* @return array An array of all available pages.
*/
public function listPages($special = true, $no_cache = false)
{
return $GLOBALS['wicked']->getPages($special, $no_cache);
}
/**
* Return basic page information.
*
* @param string $pagename Page name
*
* @return array An array of page parameters.
* @throws Wicked_Exception
*/
public function getPageInfo($pagename)
{
$page = Wicked_Page::getPage($pagename);
return array(
'page_version' => $page->_page['page_version'],
'page_checksum' => md5($page->getText()),
'version_created' => $page->_page['version_created'],
'change_author' => $page->_page['change_author'],
'change_log' => $page->_page['change_log'],
);
}
/**
* Return basic information for multiple pages.
*
* @param array $pagenames Page names
*
* @return array An array of arrays of page parameters.
* @throws Wicked_Exception
*/
public function getMultiplePageInfo($pagenames = array())
{
require_once __DIR__ . '/base.php';
if (empty($pagenames)) {
$pagenames = $GLOBALS['wicked']->getPages(false);
}
$info = array();
foreach ($pagenames as $pagename) {
$page = Wicked_Page::getPage($pagename);
$info[$pagename] = array(
'page_version' => $page->_page['page_version'],
'page_checksum' => md5($page->getText()),
'version_created' => $page->_page['version_created'],
'change_author' => $page->_page['change_author'],
'change_log' => $page->_page['change_log']
);
}
return $info;
}
/**
* Return page history.
*
* @param string $pagename Page name
*
* @return array An array of page parameters.
* @throws Wicked_Exception
*/
public function getPageHistory($pagename)
{
$page = Wicked_Page::getPage($pagename);
$summaries = $GLOBALS['wicked']->getHistory($pagename);
foreach ($summaries as $i => $summary) {
$summaries[$i]['page_checksum'] = md5($summary['page_text']);
unset($summaries[$i]['page_text']);
}
return $summaries;
}
/**
* Chech if a page exists
*
* @param string $pagename Page name
*
* @return boolean
*/
public function pageExists($pagename)
{
return $GLOBALS['wicked']->pageExists($pagename);
}
/**
* Returns a rendered wiki page.
*
* @param string $pagename Page to display
*
* @return array Page without CSS link
* @throws Wicked_Exception
*/
public function display($pagename)
{
$page = Wicked_Page::getPage($pagename);
$GLOBALS['wicked']->logPageView($page->pageName());
return $page->displayContents(false);
}
/**
* Returns a rendered wiki page.
*
* @param string $pagename Page to display
* @param string $format Format to render page to (Plain, XHtml)
*
* @return array Rendered page
* @throws Wicked_Exception
*/
public function renderPage($pagename, $format = 'Plain')
{
$page = Wicked_Page::getPage($pagename);
$content = $page->getProcessor()->transform($page->getText(), $format);
$GLOBALS['wicked']->logPageView($page->pageName());
return $content;
}
/**
* Updates content of a wiki page. If the page does not exist it is
* created.
*
* @param string $pagename Page to edit
* @param string $text Page content
* @param string $changelog Description of the change
*
* @throws Wicked_Exception
*/
public function edit($pagename, $text, $changelog = '')
{
$page = Wicked_Page::getPage($pagename);
if (!$page->allows(Wicked::MODE_EDIT)) {
throw new Wicked_Exception(sprintf(_("You don't have permission to edit \"%s\"."), $pagename));
}
if ($GLOBALS['conf']['wicked']['require_change_log'] &&
empty($changelog)) {
throw new Wicked_Exception(_("You must provide a change log."));
}
try {
$content = $page->getText();
} catch (Wicked_Exception $e) {
// Maybe the page does not exists, if not create it
if ($GLOBALS['wicked']->pageExists($pagename)) {
throw $e;
}
$GLOBALS['wicked']->newPage($pagename, $text);
}
if (trim($text) == trim($content)) {
throw new Wicked_Exception(_("No changes made"));
}
$page->updateText($text, $changelog);
}
/**
* Get a list of templates provided by Wicked. A template is any page
* whose name begins with "Template"
*
* @return arrary Array on success.
* @throws Wicked_Exception
*/
public function listTemplates()
{
global $wicked;
$templates = $wicked->getMatchingPages('Template', Wicked_Page::MATCH_ENDS);
$list = array(array('category' => _("Wiki Templates"),
'templates' => array()));
foreach ($templates as $page) {
$list[0]['templates'][] = array('id' => $page['page_name'],
'name' => $page['page_name']);
}
return $list;
}
/**
* Get a template specified by its name. This is effectively an alias for
* getPageSource() since Wicked templates are also normal pages.
* Wicked templates are pages that include "Template" at the beginning of
* the name.
*
* @param string $name The name of the template to fetch
*
* @return string Template data.
* @throws Wicked_Exception
*/
public function getTemplate($name)
{
return $this->getPageSource($name);
}
/**
* Get the wiki source of a page specified by its name.
*
* @param string $name The name of the page to fetch
* @param string $version Page version
*
* @return string Page data.
* @throws Wicked_Exception
*/
public function getPageSource($pagename, $version = null)
{
global $wicked;
$page = Wicked_Page::getPage($pagename, $version);
if (!$page->allows(Wicked::MODE_CONTENT)) {
throw new Wicked_Exception(_("Permission denied."));
}
if (!$page->isValid()) {
throw new Wicked_Exception(_("Invalid page requested."));
}
return $page->getText();
}
/**
* Process a completed template to update the named Wiki page. This
* method is basically a passthrough to edit().
*
* @param string $name Name of the new or modified page
* @param string $data Text content of the populated template
*
* @throws Wicked_Exception
*/
public function saveTemplate($name, $data)
{
$this->edit($name, $data, 'Template Auto-fill', false);
}
/**
* Returns the most recently changed pages.
*
* @param integer $days The number of days to look back.
*
* @return array Pages.
* @throws Wicked_Exception
*/
public function getRecentChanges($days = 3)
{
$info = array();
foreach ($GLOBALS['wicked']->getRecentChanges($days) as $page) {
$info[$page['page_name']] = array(
'page_version' => $page['page_version'],
'page_checksum' => md5($page['page_text']),
'version_created' => $page['version_created'],
'change_author' => $page['change_author'],
'change_log' => $page['change_log'],
);
}
return $info;
}
}
|