lib/link.php

   1 <?php
   2 // PukiWiki - Yet another WikiWikiWeb clone
   3 // $Id: link.php,v 1.20 2011/01/25 15:01:01 henoheno Exp $
   4 // Copyright (C) 2003-2007 PukiWiki Developers Team
   5 // License: GPL v2 or (at your option) any later version
   6 //
   7 // Backlinks / AutoLinks related functions
   8
   9 // ------------------------------------------------------------
  10 // DATA STRUCTURE of *.ref and *.rel files
  11
  12 // CACHE_DIR/encode('foobar').ref
  13 // ---------------------------------
  14 // Page-name1<tab>0<\n>
  15 // Page-name2<tab>1<\n>
  16 // ...
  17 // Page-nameN<tab>0<\n>
  18 //
  19 //      0 = Added when link(s) to 'foobar' added clearly at this page
  20 //      1 = Added when the sentence 'foobar' found from the page
  21 //          by AutoLink feature
  22
  23 // CACHE_DIR/encode('foobar').rel
  24 // ---------------------------------
  25 // Page-name1<tab>Page-name2<tab> ... <tab>Page-nameN
  26 //
  27 //      List of page-names linked from 'foobar'
  28
  29 // ------------------------------------------------------------
  30
  31
  32 // データベースから関連ページを得る
  33 function links_get_related_db($page)
  34 {
  35         $ref_name = CACHE_DIR . encode($page) . '.ref';
  36         if (! file_exists($ref_name)) return array();
  37
  38         $times = array();
  39         foreach (file($ref_name) as $line) {
  40                 list($_page) = explode("\t", rtrim($line));
  41                 $time = get_filetime($_page);
  42                 if($time != 0) $times[$_page] = $time;
  43         }
  44         return $times;
  45 }
  46
  47 //ページの関連を更新する
  48 function links_update($page)
  49 {
  50         if (PKWK_READONLY) return; // Do nothing
  51
  52         if (ini_get('safe_mode') == '0') set_time_limit(0);
  53
  54         $time = is_page($page, TRUE) ? get_filetime($page) : 0;
  55
  56         $rel_old        = array();
  57         $rel_file       = CACHE_DIR . encode($page) . '.rel';
  58         $rel_file_exist = file_exists($rel_file);
  59         if ($rel_file_exist === TRUE) {
  60                 $lines = file($rel_file);
  61                 unlink($rel_file);
  62                 if (isset($lines[0]))
  63                         $rel_old = explode("\t", rtrim($lines[0]));
  64         }
  65         $rel_new  = array(); // 参照先
  66         $rel_auto = array(); // オートリンクしている参照先
  67         $links    = links_get_objects($page, TRUE);
  68         foreach ($links as $_obj) {
  69                 if (! isset($_obj->type) || $_obj->type != 'pagename' ||
  70                     $_obj->name === $page || $_obj->name == '')
  71                         continue;
  72
  73                 if (is_a($_obj, 'Link_autolink')) { // 行儀が悪い
  74                         $rel_auto[] = $_obj->name;
  75                 } else {
  76                         $rel_new[]  = $_obj->name;
  77                 }
  78         }
  79         $rel_new = array_unique($rel_new);
  80
  81         // autolinkしか向いていないページ
  82         $rel_auto = array_diff(array_unique($rel_auto), $rel_new);
  83
  84         // 全ての参照先ページ
  85         $rel_new = array_merge($rel_new, $rel_auto);
  86
  87         // .rel:$pageが参照しているページの一覧
  88         if ($time) {
  89                 // ページが存在している
  90                 if (! empty($rel_new)) {
  91                         $fp = fopen($rel_file, 'w')
  92                                 or die_message('cannot write ' . htmlsc($rel_file));
  93                         fputs($fp, join("\t", $rel_new));
  94                         fclose($fp);
  95                 }
  96         }
  97
  98         // .ref:$_pageを参照しているページの一覧
  99         links_add($page, array_diff($rel_new, $rel_old), $rel_auto);
 100         links_delete($page, array_diff($rel_old, $rel_new));
 101
 102         global $WikiName, $autolink, $nowikiname, $search_non_list;
 103
 104         // $pageが新規作成されたページで、AutoLinkの対象となり得る場合
 105         if ($time && ! $rel_file_exist && $autolink
 106                 && (preg_match("/^$WikiName$/", $page) ? $nowikiname : strlen($page) >= $autolink))
 107         {
 108                 // $pageを参照していそうなページを一斉更新する(おい)
 109                 $search_non_list = 1;
 110                 $pages           = do_search($page, 'AND', TRUE);
 111                 foreach ($pages as $_page) {
 112                         if ($_page !== $page)
 113                                 links_update($_page);
 114                 }
 115         }
 116         $ref_file = CACHE_DIR . encode($page) . '.ref';
 117
 118         // $pageが削除されたときに、
 119         if (! $time && file_exists($ref_file)) {
 120                 foreach (file($ref_file) as $line) {
 121                         list($ref_page, $ref_auto) = explode("\t", rtrim($line));
 122
 123                         // $pageをAutoLinkでしか参照していないページを一斉更新する(おいおい)
 124                         if ($ref_auto)
 125                                 links_delete($ref_page, array($page));
 126                 }
 127         }
 128 }
 129
 130 // Init link cache (Called from link plugin)
 131 function links_init()
 132 {
 133         global $whatsnew;
 134
 135         if (PKWK_READONLY) return; // Do nothing
 136
 137         if (ini_get('safe_mode') == '0') set_time_limit(0);
 138
 139         // Init database
 140         foreach (get_existfiles(CACHE_DIR, '.ref') as $cache)
 141                 unlink($cache);
 142         foreach (get_existfiles(CACHE_DIR, '.rel') as $cache)
 143                 unlink($cache);
 144
 145         $ref   = array(); // 参照元
 146         foreach (get_existpages() as $page) {
 147                 if ($page == $whatsnew) continue;
 148
 149                 $rel   = array(); // 参照先
 150                 $links = links_get_objects($page);
 151                 foreach ($links as $_obj) {
 152                         if (! isset($_obj->type) || $_obj->type != 'pagename' ||
 153                             $_obj->name == $page || $_obj->name == '')
 154                                 continue;
 155
 156                         $rel[] = $_obj->name;
 157                         if (! isset($ref[$_obj->name][$page]))
 158                                 $ref[$_obj->name][$page] = 1;
 159                         if (! is_a($_obj, 'Link_autolink'))
 160                                 $ref[$_obj->name][$page] = 0;
 161                 }
 162                 $rel = array_unique($rel);
 163                 if (! empty($rel)) {
 164                         $fp = fopen(CACHE_DIR . encode($page) . '.rel', 'w')
 165                                 or die_message('cannot write ' . htmlsc(CACHE_DIR . encode($page) . '.rel'));
 166                         fputs($fp, join("\t", $rel));
 167                         fclose($fp);
 168                 }
 169         }
 170
 171         foreach ($ref as $page=>$arr) {
 172                 $fp  = fopen(CACHE_DIR . encode($page) . '.ref', 'w')
 173                         or die_message('cannot write ' . htmlsc(CACHE_DIR . encode($page) . '.ref'));
 174                 foreach ($arr as $ref_page=>$ref_auto)
 175                         fputs($fp, $ref_page . "\t" . $ref_auto . "\n");
 176                 fclose($fp);
 177         }
 178 }
 179
 180 function links_add($page, $add, $rel_auto)
 181 {
 182         if (PKWK_READONLY) return; // Do nothing
 183
 184         $rel_auto = array_flip($rel_auto);
 185
 186         foreach ($add as $_page) {
 187                 $all_auto = isset($rel_auto[$_page]);
 188                 $is_page  = is_page($_page);
 189                 $ref      = $page . "\t" . ($all_auto ? 1 : 0) . "\n";
 190
 191                 $ref_file = CACHE_DIR . encode($_page) . '.ref';
 192                 if (file_exists($ref_file)) {
 193                         foreach (file($ref_file) as $line) {
 194                                 list($ref_page, $ref_auto) = explode("\t", rtrim($line));
 195                                 if (! $ref_auto) $all_auto = FALSE;
 196                                 if ($ref_page !== $page) $ref .= $line;
 197                         }
 198                         unlink($ref_file);
 199                 }
 200                 if ($is_page || ! $all_auto) {
 201                         $fp = fopen($ref_file, 'w')
 202                                  or die_message('cannot write ' . htmlsc($ref_file));
 203                         fputs($fp, $ref);
 204                         fclose($fp);
 205                 }
 206         }
 207 }
 208
 209 function links_delete($page, $del)
 210 {
 211         if (PKWK_READONLY) return; // Do nothing
 212
 213         foreach ($del as $_page) {
 214                 $ref_file = CACHE_DIR . encode($_page) . '.ref';
 215                 if (! file_exists($ref_file)) continue;
 216
 217                 $all_auto = TRUE;
 218                 $is_page = is_page($_page);
 219
 220                 $ref = '';
 221                 foreach (file($ref_file) as $line) {
 222                         list($ref_page, $ref_auto) = explode("\t", rtrim($line));
 223                         if ($ref_page !== $page) {
 224                                 if (! $ref_auto) $all_auto = FALSE;
 225                                 $ref .= $line;
 226                         }
 227                 }
 228                 unlink($ref_file);
 229                 if (($is_page || ! $all_auto) && $ref != '') {
 230                         $fp = fopen($ref_file, 'w')
 231                                 or die_message('cannot write ' . htmlsc($ref_file));
 232                         fputs($fp, $ref);
 233                         fclose($fp);
 234                 }
 235         }
 236 }
 237
 238 function & links_get_objects($page, $refresh = FALSE)
 239 {
 240         static $obj;
 241
 242         if (! isset($obj) || $refresh)
 243                 $obj = & new InlineConverter(NULL, array('note'));
 244
 245         $result = $obj->get_objects(join('', preg_grep('/^(?!\/\/|\s)./', get_source($page))), $page);
 246         return $result;
 247 }
 248 ?>