Skip to content
Browse files

commit base code from wiki

  • Loading branch information...
0 parents commit 6580d1b1e56549fed88ae6b041301b129188f757 @andywebber committed Feb 23, 2010
Showing with 739 additions and 0 deletions.
  1. +341 −0 COPYING
  2. +10 −0 README
  3. +1 −0 VERSION
  4. +387 −0 syntax.php
341 COPYING
@@ -0,0 +1,341 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
+
10 README
@@ -0,0 +1,10 @@
+====== Orphanswanted Plugin for DokuWiki ======
+
+All documentation for the Orphanswanted Plugin is available online at:
+
+ * http://dokuwiki.org/plugin:orphanswanted
+
+(c)
+See COPYING for license info.
+
+
1 VERSION
@@ -0,0 +1 @@
+2010-02-23
387 syntax.php
@@ -0,0 +1,387 @@
+<?php
+/**
+ * OrphansWanted Plugin: Display Orphans, Wanteds and Valid link information
+ * version 2.4 2008-11-13
+ * syntax ~~ORPHANSWANTED:<choice>[!<exclude list>]~~ <choice> :: orphans | wanted | valid | all
+ * [!<exclude list>] :: optional. prefix each with ! e.g., !wiki!comments:currentyear
+ * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
+ * @author dae@douglasedmunds.com >
+ * Updated by Andy Webber to include comments from DokuWiki plugin page upto 2008-11-10
+ *
+ * Author | Date | Fix
+ * Federico Ariel Castagnini | 2009/08/24 | I have fixed the code for the backlinks, now they work.
+ */
+
+if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
+if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
+require_once(DOKU_PLUGIN.'syntax.php');
+
+require_once(DOKU_INC.'inc/search.php');
+
+
+//-------------------------------------
+
+//mod dae
+function orph_handle_link(&$data, $link) {
+ $item = &$data["$link"];
+ if(isset($item)) {
+ // This item already has a member in the array
+ // Note that the file search found it
+ $item['links'] = 1 + $item['links']; // count the link
+ // echo " <!-- added count? " . $item['links'] . " --> \n";
+ } else {
+ // Create a new entry
+ $data["$link"]=array('exists' => false, // Only found a link, not the file
+ 'links' => 1);
+ // echo " <!-- added link to list --> \n";
+ }
+}
+
+function orph_fileNS($file) {
+ $path_probs = array("!^/!", "!/$!", "!/!", "!::!");
+ $replacements = array( "", "", ":", ":");
+ $x = strrpos($file, '/');
+ switch($x) {
+ case 0:
+ $result = "";
+ break;
+ default:
+ // replace all the / with : after dropping the file off the filename
+ $result = preg_replace($path_probs, $replacements, substr($file, 1, $x -1 ));
+ }
+ //echo "<!-- $x NS= $result file= $file -->\n";
+ return $result;
+}
+
+function orph_Check_InternalLinks(&$data,$base,$file,$type,$lvl,$opts) {
+ define("LINK_PATTERN", "%\[\[([^\]|#]*)(#[^\]|]*)?\|?([^\]]*)]]%");
+
+ if(preg_match("/.*\.txt$/", $file)) {
+ global $conf;
+ // echo " <!-- checking file: $file -->\n";
+ $body = @file_get_contents($conf['datadir'] . $file);
+
+ // ignores entries in <nowiki>, %%, <code> and emails with @
+ foreach ( array("/<nowiki>[\W\w]*<\/nowiki>/",
+ "/%%.*%%/",
+ "/<code>[\W\w]*<\/code>/" ,
+ "/\[\[\\ *\\\\.*\]\]/" , //windows shares
+ "/\[\[\ *[a-zA-Z0-9._-]+@[a-zA-Z0-9-]+\..*\ *\]\]/" //email address with tags
+ //"/\[\[\ *[a-zA-Z0-9._-]+@[a-zA-Z0-9-]+\.[a-zA-Z.]+\ *\]\]/" //email address
+ //source http://www.sitepoint.com/article/regular-expressions-php
+ ) as $ignored){
+ $body = preg_replace($ignored, "", $body);
+ }
+
+ $links = array();
+ preg_match_all(LINK_PATTERN, $body, $links);
+ foreach($links[1] as $link) {
+ if( (0 < strlen(ltrim($link)))
+ and ( $link[0] <> "/" )
+ and (!preg_match("/^\ *(https?|mailto|ftp|file):/", $link)) //mod 7 june 06: allow spaces before http, etc.
+ and (!preg_match("/^(.*)>/", $link))
+ and (!strpos("@", $link)) ) {
+ // Try fixing the link...
+ //$link = preg_replace("![ ]!", "_", strtolower($link));
+ // need to fix the namespace?
+ if( $link[0] == ":" ) { // forced root namespace
+ $link = substr($link, 1);
+ //echo "\t\t<!-- !! (2) $link -->\n";
+ } else {
+ if($link[0] == ".") { // forced relative namespace
+// $link = preg_replace("!::!", ":",orph_fileNS($file) . ":" . substr($link, 1));
+ $link = resolve_id(orph_fileNS($file),$link);
+ //echo "\t\t<!-- !! (2) $link -->\n";
+ } else if(strpos($link,':') === false) {
+ $link = preg_replace("!::!", ":",orph_fileNS($file) . ":" . $link);
+ //echo "\t\t<!-- !! (3) $link -->\n";
+ }
+ } // namespace fix
+
+ if( $link[strlen($link)-1] == ":" ) {
+ $link .= $conf["start"];
+ }
+
+ // looks like an ID?
+ $link = cleanID($link);
+ if(((strlen(ltrim($link)) > 0) // there IS an id?
+ and !auth_quickaclcheck($link) < AUTH_READ)) { // should be visible to user
+// and (!preg_match("/^(http|mailto):/", $link)) // URL
+// and (!preg_match("/^(.*)>/", $link))) { // interwiki
+ //check ACL
+ //echo " <!-- adding $link -->\n";
+ //dae mod
+ //orph_handle_link(&$data, $link);
+ orph_handle_link($data, $link); }
+ } // link is not empty?
+ } // end of foreach link
+ }
+}
+
+
+function orph_report_table($data, $page_exists, $has_links, $params_array) {
+ global $conf;
+ if ($page_exists && $conf['useheading']) {
+ $show_heading = true;
+ }
+ //take off $params_array[0];
+ $exclude_array = array_slice($params_array,1);
+
+ $count = 1;
+ $output = '';
+ // for valid html - need to close the <p> that is feed before this
+ $output .= '</p>';
+ $output .= "<table class='inline'><tr><th> # </th><th> ID </th>" .
+ ($show_heading ? "<th>Title</th>" : "" ) . "<th>Links</th></tr>\n";
+
+ arsort($data);
+ foreach($data as $id=>$item) {
+
+ if(($item["exists"] == $page_exists) and (($item["links"] <> 0)== $has_links)) {
+
+ // $id is a string, looks like this: page, namespace:page, or namespace:<subspaces>:page
+ $match_array = explode(":", $id);
+ //remove last item in array, the page identifier
+ $match_array = array_slice($match_array, 0, -1);
+ //put it back together
+ $page_namespace = implode (":", $match_array);
+ //add a trailing :
+ $page_namespace = $page_namespace . ':';
+
+ //set it to show, unless blocked by exclusion list
+ $show_it = true;
+ foreach ($exclude_array as $exclude_item){
+ //add a trailing : to each $item too
+ $exclude_item = $exclude_item . ":";
+ // need === to avoid boolean false
+ // strpos(haystack, needle)
+ // if exclusion is beginning of page's namespace , block it
+ if (strpos($page_namespace, $exclude_item) === 0){
+ //there is a match, so block it
+ $show_it = false;
+ }
+ }
+
+ if ($show_it) {
+ $output .= "<tr><td>$count</td><td><a href=\"". wl($id) . "\" class=\"" . ($page_exists ? "wikilink1" : "wikilink2") . "\" onclick=\"return svchk()\" onkeypress=\"return svchk()\">" .
+ $id ."</a></td>" .
+ ($show_heading ? "<td>" . hsc(p_get_first_heading($id)) ."</td>" : "" ) .
+ "<td>" . $item["links"] .
+ ($has_links ? "&nbsp;:&nbsp;<a href=\"". wl($id,"do=backlink") . "\" class=\"wikilink1\">Show&nbsp;backlinks</a>" : "" ) .
+ "</td></tr>\n";
+
+ $count++;
+ }
+
+ }
+ }
+ //close the html table
+ $output .= "</table>\n";
+ //for valid html = need to reopen a <p>
+ $output .= "<p>";
+ return $output;
+}
+
+
+function orph_search_wanted(&$data,$base,$file,$type,$lvl,$opts) {
+
+ if($type == 'd'){
+ return true; // recurse all directories, but we don't store namespaces
+ }
+
+ if(!preg_match("/.*\.txt$/", $file)) { // Ignore everything but TXT
+ return true;
+ }
+
+ // search the body of the file for links
+ // dae mod
+ // orph_Check_InternalLinks(&$data,$base,$file,$type,$lvl,$opts);
+ orph_Check_InternalLinks($data,$base,$file,$type,$lvl,$opts);
+
+ // get id of this file
+ $id = pathID($file);
+
+ //check ACL
+ if(auth_quickaclcheck($id) < AUTH_READ) {
+ return false;
+ }
+
+ // try to avoid making duplicate entries for forms and pages
+ $item = &$data["$id"];
+ if(isset($item)) {
+ // This item already has a member in the array
+ // Note that the file search found it
+ $item['exists'] = true;
+ } else {
+ // Create a new entry
+ $data["$id"]=array('exists' => true,
+ 'links' => 0);
+ }
+ return true;
+}
+
+// --------------------
+
+/**
+ * All DokuWiki plugins to extend the parser/rendering mechanism
+ * need to inherit from this class
+ */
+class syntax_plugin_orphanswanted extends DokuWiki_Syntax_Plugin {
+ /**
+ * return some info
+ */
+ function getInfo(){
+ return array(
+ 'author' => 'Doug Edmunds',
+ 'email' => 'dae@douglasedmunds.com',
+ 'date' => '2008-11-13',
+ 'name' => 'OrphansWanted Plugin ver 2.4',
+ 'desc' => 'Find orphan pages and wanted pages .
+ syntax ~~ORPHANSWANTED:<choice>[!<excluded namespaces>]~~ .
+ <choice> :: orphans|wanted|valid|all .
+ <excluded namespaces> are optional, start each namespace with !' ,
+ 'url' => 'http://wiki.splitbrain.org/plugin:orphanswanted',
+ );
+ }
+
+ /**
+ * What kind of syntax are we?
+ */
+ function getType(){
+ return 'substition';
+ }
+
+ /**
+ * What about paragraphs?
+ */
+ function getPType(){
+ return 'normal';
+ }
+
+ /**
+ * Where to sort in?
+ */
+ function getSort(){
+ return 990; //was 990
+ }
+
+
+ /**
+ * Connect pattern to lexer
+ */
+ function connectTo($mode) {
+ $this->Lexer->addSpecialPattern('~~ORPHANSWANTED:[0-9a-zA-Z_:!]+~~',$mode,'plugin_orphanswanted');
+ }
+
+ /**
+ * Handle the match
+ */
+
+ function handle($match, $state, $pos, &$handler){
+ $match_array = array();
+ $match = substr($match,16,-2); //strip ~~ORPHANSWANTED: from start and ~~ from end
+ // Wolfgang 2007-08-29 suggests commenting out the next line
+ $match = strtolower($match);
+ //create array, using ! as separator
+ $match_array = explode("!", $match);
+ // $match_array[0] will be orphan, wanted, valid, all, or syntax error
+ // if there are excluded namespaces, they will be in $match_array[1] .. [x]
+ // this return value appears in render() as the $data param there
+ return $match_array;
+ }
+
+ /**
+ * Create output
+ */
+ function render($format, &$renderer, $data) {
+ global $INFO, $conf;
+ if($format == 'xhtml'){
+
+ // user needs to add ~~NOCACHE~~ manually to page, to assure ACL rules are followed
+ // coding here is too late, it doesn't get parsed
+ // $renderer->doc .= "~~NOCACHE~~";
+
+ // $data is an array
+ // $data[1]..[x] are excluded namespaces, $data[0] is the report type
+ //handle choices
+ switch ($data[0]){
+ case 'orphans':
+ $renderer->doc .= $this->orphan_pages($data);
+ break;
+ case 'wanted':
+ $renderer->doc .= $this->wanted_pages($data);
+ break;
+ case 'valid':
+ $renderer->doc .= $this->valid_pages($data);
+ break;
+ case 'all':
+ $renderer->doc .= $this->all_pages($data);
+ break;
+ default:
+ $renderer->doc .= "ORPHANSWANTED syntax error";
+ // $renderer->doc .= "syntax ~~ORPHANSWANTED:<choice>~~<optional_excluded> <choice> :: orphans|wanted|valid|all Ex: ~~ORPHANSWANTED:valid~~";
+ }
+
+ return true;
+ }
+ return false;
+ }
+
+
+// three choices
+// $params_array used to extract excluded namespaces for report
+// orphans = orph_report_table($data, true, false, $params_array);
+// wanted = orph_report_table($data, false, true), $params_array;
+// valid = orph_report_table($data, true, true, $params_array);
+
+
+ function orphan_pages($params_array) {
+ global $conf;
+ $result = '';
+ $data = array();
+ search($data,$conf['datadir'],'orph_search_wanted',array('ns' => $ns));
+ $result .= orph_report_table($data, true, false,$params_array);
+
+ return $result;
+ }
+
+ function wanted_pages($params_array) {
+ global $conf;
+ $result = '';
+ $data = array();
+ search($data,$conf['datadir'],'orph_search_wanted',array('ns' => $ns));
+ $result .= orph_report_table($data, false, true,$params_array);
+
+ return $result;
+ }
+
+ function valid_pages($params_array) {
+ global $conf;
+ $result = '';
+ $data = array();
+ search($data,$conf['datadir'],'orph_search_wanted',array('ns' => $ns));
+ $result .= orph_report_table($data, true, true, $params_array);
+
+ return $result;
+ }
+
+ function all_pages($params_array) {
+ global $conf;
+ $result = '';
+ $data = array();
+ search($data,$conf['datadir'],'orph_search_wanted',array('ns' => $ns));
+
+ $result .= "</p><p>Orphans</p><p>";
+ $result .= orph_report_table($data, true, false,$params_array);
+ $result .= "</p><p>Wanted</p><p>";
+ $result .= orph_report_table($data, false, true,$params_array);
+ $result .= "</p><p>Valid</p><p>";
+ $result .= orph_report_table($data, true, true, $params_array);
+
+
+ return $result;
+ }
+
+}
+
+?>

0 comments on commit 6580d1b

Please sign in to comment.
Something went wrong with that request. Please try again.