4 * Copyright 2002,2003,2007,2009 $ThePhpWikiProgrammingTeam
6 * This file is part of PhpWiki.
8 * PhpWiki is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * PhpWiki is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with PhpWiki; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 * @author: MichaelVanDam, major refactor by JeffDairiki (as AddComment)
24 * @author: Changed as baseclass to AddComment and WikiForum and EditToolbar integration by ReiniUrban.
27 require_once 'lib/TextSearchQuery.php';
30 * This plugin shows 'blogs' (comments/news) associated with a
31 * particular page and provides an input form for adding a new blog.
34 * Add <<WikiBlog >> at your PersonalPage and BlogArchive and
35 * BlogJournal will find the Blog entries automatically.
37 * Now it is also the base class for all attachable pagetypes:
38 * "wikiblog", "comment" and "wikiforum"
42 * To have the blog show up on a separate page:
44 * <<WikiBlog mode=add>>
45 * Create TopPage/Blog with this page as actionpage:
46 * <<WikiBlog pagename=TopPage mode=show>>
48 * To have the main ADMIN_USER Blog appear under Blog and not under WikiBlog/Blog
49 * or UserName/Blog as for other users blogs,
50 * define BLOG_DEFAULT_EMPTY_PREFIX=true
51 * use the page Blog as basepage
52 * and user="" (as default for ADMIN or current user) and pagename="Blog"
53 * in the various blog plugins (BlogArchives, BlogJournal)
57 * It also works as an action-page if you create a page called 'WikiBlog'
58 * containing this plugin. This allows adding comments to any page
59 * by linking "PageName?action=WikiBlog". Maybe a nice feature in
60 * lib/display.php would be to automatically check if there are
61 * blogs for the given page, then provide a link to them somewhere on
62 * the page. Or maybe this just creates a huge mess...
64 * Maybe it would be a good idea to ENABLE blogging of only certain
65 * pages by setting metadata or something...? If a page is non-bloggable
66 * the plugin is ignored (perhaps with a warning message).
68 * Should blogs be by default filtered out of RecentChanges et al???
70 * Think of better name for this module: Blog? WikiLog? WebLog? WikiDot?
72 * Have other 'styles' for the plugin?... e.g. 'quiet'. Display only
73 * 'This page has 23 associated comments. Click here to view / add.'
75 * For admin user, put checkboxes beside comments to allow for bulk removal.
77 * Permissions for who can add blogs? Display entry box only if
78 * user meets these requirements...?
80 * Code cleanup: break into functions, use templates (or at least remove CSS)
83 class WikiPlugin_WikiBlog
91 function getDescription()
93 return sprintf(_("Show and add blogs for %s."), '[pagename]');
97 // page - page which is blogged to (default current page)
99 // order - 'normal' - place in chronological order
100 // - 'reverse' - place in reverse chronological order
102 // mode - 'show' - only show old blogs
103 // 'add' - only show entry box for new blog
104 // 'show,add' - show old blogs then entry box
105 // 'add,show' - show entry box followed by old blogs
109 // - arguments to allow selection of time range to display
110 // - arguments to display only XX blogs per page (can this 'paging'
111 // co-exist with the wiki?? difficult)
112 // - arguments to allow comments outside this range to be
113 // display as e.g. June 2002 archive, July 2002 archive, etc..
114 // - captions for 'show' and 'add' sections
116 function getDefaultArguments()
118 return array('pagename' => '[pagename]',
120 'mode' => 'show,add',
125 function run($dbi, $argstr, &$request, $basepage)
127 $args = $this->getArgs($argstr, $request);
128 // allow empty pagenames for ADMIN_USER style blogs: "Blog/day"
129 //if (!$args['pagename'])
130 // return $this->error(_("No pagename specified"));
132 // Get our form args.
133 $blog = $request->getArg("edit");
134 $request->setArg("edit", false);
136 if ($request->isPost() and !empty($blog['save'])) {
137 $this->add($request, $blog, 'wikiblog', $basepage); // noreturn
141 // Now we display previous comments and/or provide entry box
144 foreach (explode(',', $args['mode']) as $show) {
145 if (!empty($seen[$show]))
151 $html->pushContent($this->showAll($request, $args));
154 $html->pushContent($this->showForm($request, $args));
157 return $this->error(sprintf("Bad mode (ā%sā)", $show));
164 * posted: required: pagename, content. optional: summary
166 function add(&$request, $posted, $type = 'wikiblog')
168 // This is similar to editpage. Shouldn't we use just this for preview?
169 $parent = $posted['pagename'];
170 if (empty($parent)) {
171 $prefix = ""; // allow empty parent for default "Blog/day"
173 } elseif (($parent == 'Blog' or $parent == 'WikiBlog') and $type == 'wikiblog') { // avoid Blog/Blog/2003-01-11/14:03:02+00:00
175 $parent = ''; // 'Blog';
176 } elseif ($parent == 'Comment' and $type == "comment") {
178 $parent = ''; // 'Comment';
179 } elseif ($parent == 'Forum' and $type == "wikiforum") {
181 $parent = ''; // 'Forum';
183 $prefix = $parent . SUBPAGE_SEPARATOR;
185 //$request->finish(fmt("No pagename specified for %s",$type));
188 $dbi = $request->getDbh();
189 $user = $request->getUser();
192 * Page^H^H^H^H Blog meta-data
193 * This method is reused for all attachable pagetypes: wikiblog, comment and wikiforum
195 * This is info that won't change for each revision.
196 * Nevertheless, it's now stored in the revision meta-data.
198 * o It's more convenient to have all information required
199 * to render a page revision in the revision meta-data.
200 * o We can avoid a race condition, since version meta-data
201 * updates are atomic with the version creation.
204 $blog_meta = array('ctime' => $now,
205 'creator' => $user->getId(),
206 'creator_id' => $user->getAuthenticatedId(),
210 $summary = trim($posted['summary']);
211 // edit: private only
212 $perm = new PagePermission();
213 $perm->perm['edit'] = $perm->perm['remove'];
214 $version_meta = array('author' => $blog_meta['creator'],
215 'author_id' => $blog_meta['creator_id'],
216 'markup' => 2.0, // assume new markup
217 'summary' => $summary ? $summary : _("New comment."),
221 'perm' => $perm->perm,
223 if ($type == 'comment')
224 unset($version_meta['summary']);
227 $body = trim($posted['content']);
230 if ($type != 'wikiforum')
231 $pagename = $this->_blogPrefix($type);
233 $pagename = substr($summary, 0, 12);
234 if (empty($pagename)) {
236 trigger_error("Empty title", E_USER_WARNING);
240 // Generate the page name. For now, we use the format:
241 // Rootname/Blog/2003-01-11/14:03:02+00:00
242 // Rootname = $prefix, Blog = $pagename,
243 // This gives us natural chronological order when sorted
244 // alphabetically. "Rootname/" is optional.
245 // Esp. if Rootname is named Blog, it is omitted.
247 $time = Iso8601DateTime();
248 // Check intermediate pages. If not existing they should RedirectTo the parent page.
249 // Maybe add the BlogArchives plugin instead for the new interim subpage.
250 $redirected = $prefix . $pagename;
251 if (!$dbi->isWikiPage($redirected)) {
252 if (!$parent) $parent = HOME_PAGE;
253 require_once 'lib/loadsave.php';
254 $pageinfo = array('pagename' => $redirected,
255 'content' => '<?plugin RedirectTo page="' . $parent . '" ?>',
256 'pagedata' => array(),
257 'versiondata' => array('author' => $blog_meta['creator'], 'is_minor_edit' => 1),
259 SavePage($request, $pageinfo, '', '');
261 $redirected = $prefix . $pagename . SUBPAGE_SEPARATOR . preg_replace("/T.*/", "", "$time");
262 if (!$dbi->isWikiPage($redirected)) {
263 if (!$parent) $parent = HOME_PAGE;
264 require_once 'lib/loadsave.php';
265 $pageinfo = array('pagename' => $redirected,
266 'content' => '<?plugin RedirectTo page="' . $parent . '" ?>',
267 'pagedata' => array(),
268 'versiondata' => array('author' => $blog_meta['creator'], 'is_minor_edit' => 1),
270 SavePage($request, $pageinfo, '', '');
273 $p = $dbi->getPage($prefix . $pagename . SUBPAGE_SEPARATOR
274 . str_replace("T", SUBPAGE_SEPARATOR, "$time"));
275 $pr = $p->getCurrentRevision();
277 // Version should be zero. If not, page already exists
278 // so increment timestamp and try again.
279 if ($pr->getVersion() > 0) {
284 // FIXME: there's a slight, but currently unimportant
285 // race condition here. If someone else happens to
286 // have just created a blog with the same name,
287 // we'll have locked it before we discover that the name
289 $saved = $p->save($body, 1, $version_meta);
295 $request->setArg("mode", "show");
296 $request->redirect($request->getURLtoSelf()); // noreturn
298 // FIXME: when submit a comment from preview mode,
299 // adds the comment properly but jumps to browse mode.
300 // Any way to jump back to preview mode???
303 function showAll(&$request, $args, $type = "wikiblog")
305 // FIXME: currently blogSearch uses WikiDB->titleSearch to
306 // get results, so results are in alphabetical order.
307 // When PageTypes fully implemented, could have smarter
308 // blogSearch implementation / naming scheme.
310 $dbi = $request->getDbh();
311 $basepage = $args['pagename'];
312 $blogs = $this->findBlogs($dbi, $basepage, $type);
316 usort($blogs, array("WikiPlugin_WikiBlog",
318 if ($args['order'] == 'reverse')
319 $blogs = array_reverse($blogs);
321 $name = $this->_blogPrefix($type);
322 if (!$args['noheader'])
323 $html->pushContent(HTML::h4(array('class' => "$type-heading"),
324 fmt("%s on %s:", $name, WikiLink($basepage))));
325 foreach ($blogs as $rev) {
326 if (!$rev->get($type)) {
327 // Ack! this is an old-style blog with data ctime in page meta-data.
328 $content = $this->_transformOldFormatBlog($rev, $type);
330 $content = $rev->getTransformedContent($type);
332 $html->pushContent($content);
339 // Subpage for the basepage. All Blogs/Forum/Comment entries are
340 // Subpages under this pagename, to find them faster.
341 function _blogPrefix($type = 'wikiblog')
343 if ($type == 'wikiblog')
345 elseif ($type == 'comment')
346 $basepage = "Comment"; elseif ($type == 'wikiforum')
347 $basepage = substr($summary, 0, 12);
348 //$basepage = _("Message"); // FIXME: we use now the first 12 chars of the summary
352 function _transformOldFormatBlog($rev, $type = 'wikiblog')
354 $page = $rev->getPage();
356 foreach (array('ctime', 'creator', 'creator_id') as $key)
357 $metadata[$key] = $page->get($key);
358 if (empty($metadata) and $type != 'wikiblog')
359 $metadata[$key] = $page->get('wikiblog');
360 $meta = $rev->getMetaData();
361 $meta[$type] = $metadata;
362 return new TransformedText($page, $rev->getPackedContent(), $meta, $type);
365 function findBlogs(&$dbi, $basepage = '', $type = 'wikiblog')
367 $prefix = (empty($basepage)
369 : $basepage . SUBPAGE_SEPARATOR) . $this->_blogPrefix($type);
370 $pages = $dbi->titleSearch(new TextSearchQuery('"' . $prefix . '"', true, 'none'));
373 while ($page = $pages->next()) {
374 if (!string_starts_with($page->getName(), $prefix))
376 $current = $page->getCurrentRevision();
377 if ($current->get('pagetype') == $type) {
386 return (strcmp($a->get('mtime'),
390 function showForm(&$request, $args, $template = 'blogform')
392 // Show blog-entry form.
393 $args = array('PAGENAME' => $args['pagename'],
395 HiddenInputs($request->getArgs()));
396 if (ENABLE_EDIT_TOOLBAR and !ENABLE_WYSIWYG and ($template != 'addcomment')) {
397 include_once 'lib/EditToolbar.php';
398 $toolbar = new EditToolbar();
399 $args = array_merge($args, $toolbar->getTokens());
401 return new Template($template, $request, $args);
404 // "2004-12" => "December 2004"
405 function _monthTitle($month)
407 if (!$month) $month = strftime("%Y-%m");
408 //list($year,$mon) = explode("-",$month);
409 return strftime("%B %Y", strtotime($month . "-01"));
412 // "UserName/Blog/2004-12-13/12:28:50+01:00" => array('month' => "2004-12", ...)
413 function _blog($rev_or_page)
415 $pagename = $rev_or_page->getName();
416 if (preg_match("/^(.*Blog)\/(\d\d\d\d-\d\d)-(\d\d)\/(.*)/", $pagename, $m))
417 list(, $prefix, $month, $day, $time) = $m;
418 return array('pagename' => $pagename,
419 // page (list pages per month) or revision (list months)?
420 //'title' => isa($rev_or_page,'WikiDB_PageRevision') ? $rev_or_page->get('summary') : '',
421 //'monthtitle' => $this->_monthTitle($month),
425 'prefix' => $prefix);
428 function _nonDefaultArgs($args)
430 return array_diff_assoc($args, $this->getDefaultArguments());
439 // c-hanging-comment-ender-p: nil
440 // indent-tabs-mode: nil