Changeset 7057

Timestamp:

01/15/08 00:11:26 (9 months ago)

Author:

naholyr

Message:

[nahoWikiPlugin]
Add basic permission management
Add "Index By Title"
Add namespaces
Add breadcrumbs
Add slots
Updated README
Refactoring
Add support for Interwiki (dokuwiki style)
Add div wrapper
Add nice CSS
Add some helpers

Files:

• plugins/nahoWikiPlugin/trunk (modified) (1 prop)
• plugins/nahoWikiPlugin/trunk/CHANGELOG (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/README (modified) (6 diffs)
• plugins/nahoWikiPlugin/trunk/config/app.yml (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/config/config.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/config/config_handlers.yml (added)
• plugins/nahoWikiPlugin/trunk/config/interwiki.yml (added)
• plugins/nahoWikiPlugin/trunk/data (added)
• plugins/nahoWikiPlugin/trunk/data/fixtures (added)
• plugins/nahoWikiPlugin/trunk/lib/helper/nahoWikiHelper.php (modified) (4 diffs)
• plugins/nahoWikiPlugin/trunk/lib/model/plugin/PluginnahoWikiContentPeer.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/lib/model/plugin/PluginnahoWikiPage.php (modified) (3 diffs)
• plugins/nahoWikiPlugin/trunk/lib/model/plugin/PluginnahoWikiPagePeer.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/lib/model/plugin/PluginnahoWikiRevision.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/lib/nahoWikiConfigHandler.php (added)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/lib/BasenahoWikiActions.class.php (modified) (10 diffs)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/lib/BasenahoWikiComponents.class.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_breadcrumbs.php (added)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_content.php (added)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_diff.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_index.php (added)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_page.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_page_actions.php (added)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_page_edit.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_page_history.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_page_tools.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/_toc.php (added)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/browseSuccess.php (added)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/diffSuccess.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/editSuccess.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/historySuccess.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/userSuccess.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/modules/nahoWiki/templates/viewSuccess.php (modified) (1 diff)
• plugins/nahoWikiPlugin/trunk/package.xml (modified) (3 diffs)
• plugins/nahoWikiPlugin/trunk/web/css/default.css (modified) (2 diffs)
• plugins/nahoWikiPlugin/trunk/web/images (added)
• plugins/nahoWikiPlugin/trunk/web/images/article.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/breadcrumbs.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/dir_closed.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/dir_open.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki.png (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/amazon.de.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/amazon.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/amazon.uk.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/coral.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/doku.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/dokubug.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/google.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/meatball.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/php.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/sb.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/wiki.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/wp.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/wpde.gif (added)
• plugins/nahoWikiPlugin/trunk/web/images/interwiki/wpmeta.gif (added)

plugins/nahoWikiPlugin/trunk/CHANGELOG

@@ -1 +1 @@
-== 0.0.1 ==
-
-2007-12-05
+
-  - Initial public release/check-in.

plugins/nahoWikiPlugin/trunk/README

@@ -3 +3 @@
-== Overview ==
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-== Screenshots ==
-
-
-
-
-
+
+
+
-
-== Requirements ==
-
-The prerequisites for using the `nahoWiki` plugin are:
-Currently only the Markdown syntax is supported, and this makes the [http://trac.symfony-project.com/trac/wiki/sfMarkdownPlugin sfMarkdownPlugin] a mandatory dependancy
-r `myUser` class must define a well written `__toString()` method, as the plugin will only store this data (no ID is stored, all the history of a user is based on his nickname given by `__toString()`). If you don't have a user-managerment system, [http://trac.symfony-project.com/trac/wiki/sfGuardPlugin sfGuardPlugin] is a good choice but is not mandatory
+As the plugin doesn't contain a user management module, the project where you install it must have a table managing authors, or users (whatever the name), and the related Propel class must have a `__toString()` method. Both these conditions are satisfied by the [http://trac.symfony-project.com/trac/wiki/sfGuardPlugin sfGuardPlugin], so installing this plugin is a good choice
+ need the [http://trac.symfony-project.com/trac/wiki/sfMarkdownPlugin sfMarkdownPlugin] which will provide the ability to convert from wiki syntax to XHTML contents
-
-== Installation ==
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-{{{
-$ svn propedit svn:externals plugins
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-}}}
-
@@ -82 +73 @@
-{{{
-$ php symfony cc
+}}}
+
+You can load the included fixtures to start using the forum with test data.
+{{{
+$ php symfony propel-load-data frontend plugins/nahoWikiplugin/data/fixtures
-}}}
-
@@ -89 +85 @@
-all:
-  .settings:
-default
+...
-}}}
-
-Start using the plugin by browsing to the frontend module's default page:
- 
+
-http://myproject/frontend_dev.php/nahoWiki
-}}}
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-== Configuration ==
@@ -105 +124 @@
-=== Schema customization ===
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-=== app.yml ===
@@ -114 +182 @@
-all:
-  nahoWikiPlugin:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-}}}
-
-=== Routing rules ===
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-=== Look and Feel ===
@@ -136 +266 @@
-}}}
-
+== nahoWiki specific features ==
+
+=== Helpers ===
+
+nahoWiki provides a bunch of helpers to help you integrate the wiki in your application.
+
+You can insert links to wiki pages, anywhere in your application :
+
+  - link_to_diff($text, $page_name, $rev1, $rev2, $mode = 'inline')
+  - link_to_raw_diff($text, $page_name, $rev1, $rev2, $mode = 'unified')
+  - url_for_wiki($page_name, $revision = null)
+  - link_to_wiki($text, $page_name, $options = array(), $revision = null)
+  - url_for_wiki_user($username, $revision = null)
+  - link_to_wiki_user($text, $username, $options = array(), $revision = null)
+  - url_for_wiki_discuss($page_name, $revision = null)
+  - link_to_wiki_discuss($text, $page_name, $options = array(), $revision = null)
+
+You can even insert the content of a wiki page using `include_wiki` :
+
+  - include_wiki($page_name, $revision = null, $options = array())
+  - get_wiki($page_name, $revision = null, $options = array())
+
+The last two helpers are just shortcuts to use nahoWiki component.
+
+=== Interwiki ===
+
+nahoWiki provides basic support for Interwiki.
+
+The main syntax is `[[Key>PageName Title]]`, and it outputs a link to the page "PageName" of the wiki named "Key", preceded by a nice icon telling the user this is an Interwiki link.
+
+If the file named `web/nahoWikiPlugin/images/interwiki/key.gif` exists (or `.png` or `.jpg`) it will be used, else we use the generic `interwiki.png` [[Image(source:/plugins/nahoWikiPlugin/web/images/interwiki.png)]]
+
+To add a new Interwiki, just create a file named `interwiki.yml` in your app's folder, and add the key you want :
+
+{{{
+all:
+  Key: "http://UrlOfTheWiki?page="
+}}}
+
+The page name provided in the link is just added to the corresponding URL.
+
+=== Internal links ===
+
+The syntax for internal links is `[[PageName Title]]`.
+
+Page names support namespaces.
+
+If an internal link points to a unexisting page, it's show to the user, using different models : `internal_link_model` for links to existing pages, `internal_link_broken_model` for links to unexisting pages.
+
+==== Namespaces ====
+
+Namespaces work just the same way than [http://www.splitbrain.org/projects/dokuwiki DokuWiki]
+
-== TODO ==
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+

plugins/nahoWikiPlugin/trunk/config/app.yml

@@ -1 @@
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

plugins/nahoWikiPlugin/trunk/config/config.php

@@ -1 +1 @@
-<?php
-
-
+
+
+
-
-
+
+
+
+
-{
-  $r = sfRouting::getInstance();
-
-  // preprend our routes
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-}

plugins/nahoWikiPlugin/trunk/lib/helper/nahoWikiHelper.php

@@ -1 +1 @@
-<?php
-
+/**
+ * Get link to the diff page between two revisions of a page
+ *
+ * @param string $page_name
+ * @param int $revision
+ *
+ * @return string
+ */
-function link_to_diff($text, $page_name, $rev1, $rev2, $mode = 'inline')
-{
@@ -6 +14 @@
-}
-
+/**
+ * Get link for the discussion page of a page in the wiki
+ *
+ * @param string $text text of the link
+ * @param string $page_name
+ * @param int $revision
+ *
+ * @return string
+ */
-function link_to_raw_diff($text, $page_name, $rev1, $rev2, $mode = 'unified')
-{
@@ -11 +28 @@
-}
-
+/**
+ * Get URL for a page in the wiki
+ *
+ * @param string $page_name
+ * @param int $revision
+ *
+ * @return string
+ */
-function url_for_wiki($page_name, $revision = null)
-{
@@ -16 +41 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
+
-{
-
-
-
+
+
+
+
+
-  }
-
-
+, $options
-}
+
+/**
+ * Get URL for the presentation page of a user in the wiki
+ *
+ * @param string $username
+ * @param int $revision
+ *
+ * @return string
+ */
+function url_for_wiki_user($username, $revision = null)
+{
+  return url_for_wiki($text, 'user:' . $username);
+}
+
+/**
+ * Get link for the presentation page of a user in the wiki
+ *
+ * @param string $text text of the link
+ * @param string $username
+ * @param array $options params added to the link
+ * @param int $revision
+ *
+ * @return string
+ */
+function link_to_wiki_user($text, $username, $options = array(), $revision = null)
+{
+  return link_to_wiki($text, 'user:' . $username, $options, $revision);
+}
+
+/**
+ * Get URL for the discussion page of a page in the wiki
+ *
+ * @param string $page_name
+ * @param int $revision
+ *
+ * @return string
+ */
+function url_for_wiki_discuss($page_name, $revision = null)
+{
+  return url_for_wiki('discuss:' . $page_name, $revision);
+}
+
+/**
+ * Get link for the discussion page of a page in the wiki
+ *
+ * @param string $text text of the link
+ * @param string $page_name
+ * @param array $options params added to the link
+ * @param int $revision
+ *
+ * @return string
+ */
+function link_to_wiki_discuss($text, $page_name, $options = array(), $revision = null)
+{
+  return link_to_wiki($text, 'discuss:' . $page_name, $options, $revision);
+}
+
+/**
+ * Include (display) a wiki page
+ *
+ * Options that can be used :
+ * - display_toc => false # Hide the Table of contents
+ * - display_pagename => false # Hide the page name
+ *
+ * @param string $page_name fully qualified page name
+ * @param array $options additional options
+ * @param int $revision
+ */
+function include_wiki($page_name, $revision = null, $options = array())
+{
+  $options['pagename'] = $page_name;
+  $options['revision'] = $revision;
+  include_component('nahoWiki', 'content', $options);
+}
+
+/**
+ * Returns XHTML content of a wiki page
+ *
+ * Options that can be used :
+ * - display_toc => false # Hide the Table of contents
+ * - display_pagename => false # Hide the page name
+ *
+ * @param string $page_name fully qualified page name
+ * @param array $options additional options
+ * @param int $revision
+ */
+function get_wiki($page_name, $revision = null, $options = array())
+{
+  $options['pagename'] = $page_name;
+  $options['revision'] = $revision;
+  return get_component('nahoWiki', 'content', $options);
+}

plugins/nahoWikiPlugin/trunk/lib/model/plugin/PluginnahoWikiContentPeer.php

@@ -10 +10 @@
-class PluginnahoWikiContentPeer extends BasenahoWikiContentPeer
-{
+  
+  public static function doConvert($content)
+  {
+    if (class_exists('sfMarkdown')) {
+      return sfMarkdown::doConvert($content);
+    } else {
+      return $content;
+    }
+  }
+  
+  public static function makeReplacements($replaces, $content)
+  {
+    foreach ($replaces as $replace) {
+      if (is_array($replace['to'])) {
+        $content = preg_replace_callback($replace['from'], $replace['to'], $content);
+      } else {
+        $content = preg_replace($replace['from'], $replace['to'], $content);
+      }
+    }
+    
+    return $content;
+  }
+  
+  public static function preConvert($page, $content)
+  {
+    // Convert nahoWiki-specific internal links to a syntax compatible with the chosen wiki engine
+    $content = self::convertInternalLinks($page, $content);
+    $content = self::convertInterwikiLinks($content);
+    
+    // Regexp replacements
+    $replaces = sfConfig::get('app_nahoWikiPlugin_replace_before', array());
+    
+    return self::makeReplacements($replaces, $content);
+  }
+  
+  public static function postConvert($page, $html)
+  {
+    $replaces = sfConfig::get('app_nahoWikiPlugin_replace_after', array());
+    
+    // Add the rule to insert ID to titles (support for anchors)
+    $replaces[] = array(
+      'from' => '/<(h[1-6])( .*+)?>(.*?)<\/\1>/i',
+      'to'   => array('self', 'callbackNameTitle')
+    );
+    
+    // Add the rule to apply security filters
+    $tags = sfConfig::get('app_nahoWikiPlugin_strip_tags', array('script', 'embed', 'object'));
+    if (count($tags)) {
+      $replaces[] = array(
+        'from' => '/<(' . implode('|', $tags) . ')( .+?)?>.*?<\/\1>/i',
+        'to'   => ''
+      );
+    }
+    
+    return self::makeReplacements($replaces, $html);
+  }
+  
+  protected static function extractLinkReplacements($content, $masks, $pcre_masks)
+  {
+    $replaces = array(); // hash of string-replacements to make
+    foreach ($masks as $mask) {
+      // extract mask elements
+      preg_match_all('/%(' . implode('|', array_keys($pcre_masks)) . ')%/', $mask, $elements);
+      $elements = $elements[1];
+      // convert the mask to preg-compatible one
+      $mask = preg_quote($mask, '/');
+      foreach ($pcre_masks as $mask_id => $pcre) {
+        $mask = str_replace('%' . $mask_id . '%', '(' . $pcre . ')', $mask);
+      }
+      // extract all corresponding items
+      preg_match_all('/' . $mask . '/i', $content, $items, PREG_SET_ORDER);
+      // delete them from working copy of content
+      $content = preg_replace('/' . $mask . '/', '', $content);
+      foreach ($items as $item) {
+        if (!isset($replaces[$item[0]])) {
+          // We did not handle this link yet
+          $name = $title = '';
+          foreach ($elements as $i => $element) {
+            // Initialize $name and $title found by regexp
+            $$element = $item[$i+1];
+          }
+          // default values & required elements
+          if (!$name) {
+            continue;
+          }
+          @list($name, $anchor) = explode('#', $name, 2);
+          $replaces[$item[0]] = array('name' => $name, 'title' => $title, 'anchor' => $anchor, 'link' => '#');
+        }
+      }
+    }
+    
+    return $replaces;
+  }
+  
+  protected static function makeLinkReplacements($content, $replaces, $link_model, $existing_page = null, $broken_link_model = null) {
+    // make full-text replacements
+    foreach ($replaces as $source => $replace) {
+      if (@$replace['link']) {
+        // use the good model in app.yml, depending on wether the page exists or not
+        if (!is_null($existing_page) && !is_null($broken_link_model) && !isset($existing_page[$replace['name']])) {
+          $destination = $broken_link_model;
+        } else {
+          $destination = $link_model;
+        }
+        // replace by the customized model
+        $destination = str_replace(
+          array('%name%', '%title%', '%link%', '%image%', '%alttext%'), 
+          array($replace['name'], $replace['title'], $replace['link'], @$replace['image'], @$replace['alttext']),
+          $destination);
+        $content = str_replace($source, $destination, $content);
+      }
+    }
+    
+    return $content;
+  }
+  
+  public static function convertInternalLinks($page, $content)
+  {
+    $masks = sfConfig::get('app_nahoWikiPlugin_internal_links', array('[[%name% %title%]]', '[[%name%]]'));
+    $pcre_masks = array(
+      'name'  => nahoWikiPagePeer::pageNameFormat() . '(?:#[A-Za-z0-9_\-]+)?',
+      'title' => '.*?',
+    );
+    
+    $replaces = self::extractLinkReplacements($content, $masks, $pcre_masks);
+    
+    // Extract names and complete the replacements array
+    $names = array();
+    $controller = sfContext::getInstance()->getController();
+    foreach ($replaces as &$replace) {
+      // Full name
+      $replace['name'] = $page->resolveAbsoluteName($replace['name']);
+      // Title
+      if (!$replace['title']) {
+        $replace['title'] = nahoWikiPagePeer::getBasename($replace['name']);
+      }
+      // Link
+      $url = 'nahoWiki/view?page=' . urlencode($replace['name']);
+      if (@$replace['anchor']) {
+        $url .= '#' . $replace['anchor'];
+      }
+      $replace['link'] = $controller->genUrl($url, false);
+      // Store name
+      $names[] = $replace['name'];
+    }
+    
+    // Find all existing pages
+    $existing_page = array();
+    $pages = nahoWikiPagePeer::retrieveByNames($names);
+    foreach ($pages as $page) {
+      $existing_page[$page->getName()] = true;
+    }
+    
+    $link_model = sfConfig::get('app_nahoWikiPlugin_internal_link_model', '[%title%](%link%)');
+    $broken_link_model = sfConfig::get('app_nahoWikiPlugin_internal_link_broken_model', '[%title%(?)](%link%)');
+    
+    return self::makeLinkReplacements($content, $replaces, $link_model, $existing_page, $broken_link_model);
+  }
+  
+  public static function convertInterwikiLinks($content)
+  {
+    $masks = sfConfig::get('app_nahoWikiPlugin_interwiki_links', array('[[%name% %title%]]', '[[%name%]]'));
+    $pcre_masks = array(
+      'name'  => '[a-z]+>' . nahoWikiPagePeer::pageNameFormat() . '(?:#[A-Za-z0-9_\-]+)?',
+      'title' => '.*?',
+    );
+    
+    $replaces = self::extractLinkReplacements($content, $masks, $pcre_masks);
+    
+    // Complete the replacements array
+    $interwiki = sfConfig::get('app_nahoWikiPlugin_interwiki', array());
+    $web_root = sfContext::getInstance()->getRequest()->getRelativeUrlRoot();
+    $dir_root = sfConfig::get('sf_web_dir');
+    $plugin_dir = '/nahoWikiPlugin/images/';
+    foreach ($replaces as &$replace) {
+      list($key, $name) = explode('>', $replace['name'], 2);
+      if (isset($interwiki[$key])) {
+        $replace['link'] = $interwiki[$key] . rawurlencode($name);
+        if ($replace['link']) {
+          $replace['alttext'] = $key;
+          $key = strtolower($key);
+          if (is_file($dir_root . ($image = $plugin_dir . 'interwiki/' . $key . '.png'))) {
+            $replace['image'] = $web_root . $image;
+          } elseif (is_file($dir_root . ($image = $plugin_dir . 'interwiki/' . $key . '.gif'))) {
+            $replace['image'] = $web_root . $image;
+          } elseif (is_file($dir_root . ($image = $plugin_dir . 'interwiki/' . $key . '.jpg'))) {
+            $replace['image'] = $web_root . $image;
+          } else {
+            $replace['image'] = $web_root . $plugin_dir . 'interwiki.png';
+          }
+        }
+        if (!$replace['title']) {
+          $replace['title'] = $name;
+        }
+      }
+    }
+    
+    $link_model = sfConfig::get('app_nahoWikiPlugin_interwiki_link_model', '[![%alttext%](%image%) %title%](%link%)');
+    
+    return self::makeLinkReplacements($content, $replaces, $link_model);
+  }
+