SuikaWiki/Plugin/WikiPageProp.wp2

#?SuikaWikiConfig/2.0

Plugin:
  @Name: WikiPageProp
  @Description:
    @@@: WikiPage property
    @@lang:en
  @License: %%GPL%%
  @Author:
    @@Name:
      @@@@: Wakaba
      @@@lang:ja
      @@@script:Latn
    @@Mail[list]: w@suika.fam.cx
  @Date.RCS: $Date: 2004/01/16 07:48:39 $
  @RequiredModule[list]:
    WikiFormat
  @Use:
    use Message::Util::Error;

PluginConst:
  @NS_XHTML1:
    http://www.w3.org/1999/xhtml

FormattingRule:
  @Category[list]:
    view
    view-resource
    form-input
  @Name: last-modified
  @Description:
    @@@:
      Last-modified date-time of the WikiPage.
      \
      Note: Date-time value returned by this rule might not be 
      the "real" last-modified date-time, in case last-modified 
      value is not updated when content is modified (so called 
      "sage" feature).
    @@lang: en
  @Parameter:
    @@Name: page
    @@Type: WikiName
    @@Default: (current)
    @@Description:
      @@@@: Target WikiPage
      @@@lang:en
  @Formatting:
    __ATTRTEXT:%page__;
    my $page = length $p->{page} ?
                 [split $o->{wiki}->{config}->{name}->{space}->{separator_regex},
                        $p->{page}]:
                 $o->{wiki}->{var}->{page};
    my $lm;
    try {
      $lm = $o->{wiki}->{db}->get (lastmodified => $page);
    } catch SuikaWiki::DB::Util::Error with {
      $lm = 0;
    }
    $p->{-parent}->append_text ( __FUNCPACK__::unixtime_to_string ($lm));
## TODO: format string

FormattingRule:
  @Category[list]: page-link
  @Name: last-modified
  @Description:
    @@@:
      Last-modified date-time of the WikiPage.
      \
      Note: Date-time value returned by this rule might not be
      the "real" last-modified date-time, in case last-modified
      value is not updated when content is modified (so called
      "sage" feature).
    @@lang: en
  @Formatting:
    my $date;
    if (defined $o->{link}->{dest}->{page_lastmodified}) {
      $date = $o->{link}->{dest}->{page_lastmodified};
    } else {
## TODO:
      my $page = $o->{link}->{dest}->{page_name};
      try {
        $date = $o->{wiki}->{db}->get (lastmodified => $page);
      } catch SuikaWiki::DB::Util::Error with {
        $date = 0;
      };
    }
    $p->{-parent}->append_text (__FUNCPACK__::unixtime_to_string ($date));
## TODO: Update to new interface

FormattingRule:
  @Category[list]:
    view
    view-resource
    form-input
  @Name: page-name
  @Description:
    @@@:
      WikiName in string repersentation
    @@lang: en
  @Parameter:
    @@Name:separator
    @@Type:string
    @@Default:(config)
    @@Description:
      @@@@:Separator used to delimit namespace components (ie. path delimiter)
      @@@lang:en
  @Formatting:
    __ATTRTEXT:%page__;
## TODO:
    my $page = length $p->{page} ?
                 [split $o->{wiki}->{config}->{name}->{space}->{separator_regex},
                        $p->{page}]:
                 $o->{wiki}->{var}->{page};
    $p->{-parent}->append_text (join
      (($p->{separator} || $o->{wiki}->{config}->{name}->{space}->{separator}),
       @{$page}));

FormattingRule:
  @Category[list]:page-link
  @Name: page-name
  @Description:
    @@@:WikiName in string representation
    @@lang:en
  @Parameter:
    @@Name:relative
    @@Type:boolean
    @@Default:"0"
    @@Description:
      @@@@:Whether WikiName should be relative to "this" page
      @@@lang:en
  @Formatting:
    __ATTRTEXT:%relative__;
    if ($p->{relative}) {
      $p->{-parent}->append_text (join '//', @{$o->{link}->{dest}->{page_name_relative}});
    } else {
      $p->{-parent}->append_text (join '//', @{$o->{link}->{dest}->{page_name}});
    }

FormattingRule:
  @Category[list]:page-link
  @Name: page-title
  @Description:
    @@@:Title of the WikiPage
    @@lang:en
  @Parameter:
    @@Name:relative
    @@Type:boolean
    @@Default:"0"
    @@Description:
      @@@@:Whether relative to "this" page
      @@@lang:en
  @Formatting:
    __ATTRTEXT:%relative__;
    if (defined $o->{link}->{dest}->{page_title}) {
 ## ISSUE: Is this work now?
      $p->{-parent}->append_text ($o->{link}->{dest}->{page_title});
    } elsif ($p->{relative}) {
      $p->{-parent}->append_text (join '//', @{$o->{link}->{dest}->{page_name_relative}});
    } else {
      $p->{-parent}->append_text (join '//', @{$o->{link}->{dest}->{page_name}});
    }

FormattingRule:
  @Category[list]:page-link
  @Name:page-headline
  @Description:
    @@@:Headline summary of the WikiPage
    @@lang:en
  @Formatting:
    $p->{-parent}->append_text 
      (__FUNCPACK__->get_headsummary
 ## TODO: 
         ($o->{link}->{dest}->{page_name},
          wiki => $o->{wiki}));

FormattingRule:
  @Category[list]: form-input
  @Name: wpp--next-anchor-index
  @Description:
    @@@: Next "anchor index" number
    @@lang: en
  @Formatting:
      my $page = $o->{wiki}->{var}->{page};
      my $content;
      try {
        $content = $o->{wiki}->{db}->get (content => $page);
      } catch SuikaWiki::DB::Util::Error with {
        $content = undef;
      };

      ## Get Format Handler
      my $format = SuikaWiki::Plugin->module_package ('WikiFormat')
                                    ->handler (\$content,
                                               wiki => $o->{wiki});

      $p->{-parent}->append_text ($format->next_index_for_anchor
                                             (\$content, wiki => $o->{wiki},
                                              page => $page));

Function:
  @Name: unixtime_to_string
  @Description
    @@@:
      Convert internal date-time format to other (possibly human readable) 
      format.
      \
      Note: Currently, only one fixed format is supported, whilst 
      future version is expected to support highly customizable 
      formatting supported by Message::Field::Date.
    @@lang:en
  @Main:
    my @date = gmtime shift;
    sprintf '%04d-%02d-%02d %02d:%02d:%02d +00:00',
            $date[5] + 1900,
            $date[4] + 1,
            @date[3,2,1,0];

Function:
  @Name: get_headsummary
  @Description:
    @@@: Returns headline summary
    @@lang:en
  @Main:
    my (undef, $page, %opt) = @_;
    $page ||= $opt{wiki}->{var}->{page};
    
    my $s;
    try {
      if ($opt{wiki}->{db}->exist (wpp__headsummary => $page)) {
        $s = $opt{wiki}->{db}->get (wpp__headsummary => $page);
      } else {
        my $content = $opt{wiki}->{db}->get (content => $page);
        
        ## Get Format Handler
        my $format = SuikaWiki::Plugin->module_package ('WikiFormat')
                                      ->handler (\$content,
                                                 wiki => $opt{wiki});
        $s = $format->headsummary (\$content, wiki => $opt{wiki}); 
  
        $s =~ tr/\x0D//d;
        if (length ($s) > 500) {
          $s = substr ($s, 0, 500);
          $s =~ s/[^\x09\x0A\x20-\x7E]+$//;
          $s .= '...';
        }
        if ($s =~ /^([^\x0A]*(?:\x0A+[^\x0A]+){0,9})/) {
          $s = $1;
        }
        $s =~ s/[\x09\x0A\x20]+/\x20/gs;
        $s =~ s/\([^\(\)]+\)//g;
        $s =~ s/\[[^\[\]]+\]//g;
        $s =~ s/>>[0-9]+//g;
        $s =~ s/<[^<>]+>//g;
        $s =~ s/{[^{}]+}//g;
        $s =~ s/20[0-9][0-9]-[01][0-9]-[0-3][0-9][T\x20]*[0-2][0-9]:[0-5][0-9]:[0-5][0-9](?:\s*[+-][0-9][0-9]:[0-9][0-9])?//g;
        $s =~ s/ [Aa]n? / /g;
                  $s =~ s/ [Aa]t / @ /g;
                  $s =~ s/ [Tt]he / /g;
                  $s =~ s/,? and / & /g;
                  $s =~ s!,? or ! / !g;
                  $s =~ s! not !n't !g;
                  $s =~ s! (?:i|ha)s !'s !g;
                  $s =~ s! are !'re !g;
                  $s =~ s! [Ww]ith(in|out)? !' w/'.substr ($1,0,1).' '!ge;
        $s =~ s![.,]\x20?$!!g;
        $s =~ s/\x20+/\x20/g;
        if (length ($s) > 400) {
          $s = substr ($s, 0, 400);
          $s =~ s/[^\x20-\x7E]+$//s; # Remove broken EUC-JP char
          $s .= '...';
        }
        $opt{wiki}->{db}->set (wpp__headsummary => $page => $s);
      }
    } catch SuikaWiki::DB::Util::Error with {
      $s = undef;
    };
    return $s;

ViewFragment:
  @Name: ws--post-content
  @Description:
    @@@: After content body -- last modified date and time of the WikiPage
    @@lang:en
  @Order: 800
  @Formatting:
        %block (
          id => last-modified,
          content => {%res(name=>{LastModified=});%last-modified;}p,
        );

Resource:
  @LastModified=:
    @@@:
      Last modified: 
    @@lang: en
1	wakaba	1.1	#?SuikaWikiConfig/2.0
2
3			Plugin:
4			@Name: WikiPageProp
5			@Description:
6			@@@: WikiPage property
7			@@lang:en
8			@License: %%GPL%%
9			@Author:
10			@@Name:
11			@@@@: Wakaba
12			@@@lang:ja
13			@@@script:Latn
14			@@Mail[list]: w@suika.fam.cx
15	wakaba	1.3	@Date.RCS: $Date: 2004/01/16 07:48:39 $
16	wakaba	1.2	@RequiredModule[list]:
17			WikiFormat
18	wakaba	1.3	@Use:
19			use Message::Util::Error;
20	wakaba	1.1
21			PluginConst:
22			@NS_XHTML1:
23			http://www.w3.org/1999/xhtml
24
25			FormattingRule:
26			@Category[list]:
27			view
28			view-resource
29			form-input
30			@Name: last-modified
31			@Description:
32			@@@:
33			Last-modified date-time of the WikiPage.
34			\
35			Note: Date-time value returned by this rule might not be
36			the "real" last-modified date-time, in case last-modified
37			value is not updated when content is modified (so called
38			"sage" feature).
39			@@lang: en
40			@Parameter:
41			@@Name: page
42			@@Type: WikiName
43			@@Default: (current)
44			@@Description:
45			@@@@: Target WikiPage
46			@@@lang:en
47			@Formatting:
48			__ATTRTEXT:%page__;
49			my $page = length $p->{page} ?
50			[split $o->{wiki}->{config}->{name}->{space}->{separator_regex},
51			$p->{page}]:
52			$o->{wiki}->{var}->{page};
53	wakaba	1.3	my $lm;
54			try {
55			$lm = $o->{wiki}->{db}->get (lastmodified => $page);
56			} catch SuikaWiki::DB::Util::Error with {
57			$lm = 0;
58			}
59			$p->{-parent}->append_text ( __FUNCPACK__::unixtime_to_string ($lm));
60	wakaba	1.1	## TODO: format string
61
62			FormattingRule:
63			@Category[list]: page-link
64			@Name: last-modified
65			@Description:
66			@@@:
67			Last-modified date-time of the WikiPage.
68			\
69			Note: Date-time value returned by this rule might not be
70			the "real" last-modified date-time, in case last-modified
71			value is not updated when content is modified (so called
72			"sage" feature).
73			@@lang: en
74			@Formatting:
75			my $date;
76			if (defined $o->{link}->{dest}->{page_lastmodified}) {
77			$date = $o->{link}->{dest}->{page_lastmodified};
78			} else {
79			## TODO:
80	wakaba	1.3	my $page = $o->{link}->{dest}->{page_name};
81			try {
82			$date = $o->{wiki}->{db}->get (lastmodified => $page);
83			} catch SuikaWiki::DB::Util::Error with {
84			$date = 0;
85			};
86	wakaba	1.1	}
87			$p->{-parent}->append_text (__FUNCPACK__::unixtime_to_string ($date));
88			## TODO: Update to new interface
89
90			FormattingRule:
91			@Category[list]:
92			view
93			view-resource
94			form-input
95			@Name: page-name
96			@Description:
97			@@@:
98			WikiName in string repersentation
99			@@lang: en
100			@Parameter:
101			@@Name:separator
102			@@Type:string
103			@@Default:(config)
104			@@Description:
105			@@@@:Separator used to delimit namespace components (ie. path delimiter)
106			@@@lang:en
107			@Formatting:
108			__ATTRTEXT:%page__;
109			## TODO:
110			my $page = length $p->{page} ?
111			[split $o->{wiki}->{config}->{name}->{space}->{separator_regex},
112			$p->{page}]:
113			$o->{wiki}->{var}->{page};
114			$p->{-parent}->append_text (join
115			(($p->{separator} \|\| $o->{wiki}->{config}->{name}->{space}->{separator}),
116			@{$page}));
117
118			FormattingRule:
119			@Category[list]:page-link
120			@Name: page-name
121			@Description:
122			@@@:WikiName in string representation
123			@@lang:en
124			@Parameter:
125			@@Name:relative
126			@@Type:boolean
127			@@Default:"0"
128			@@Description:
129	wakaba	1.3	@@@@:Whether WikiName should be relative to "this" page
130	wakaba	1.1	@@@lang:en
131			@Formatting:
132			__ATTRTEXT:%relative__;
133			if ($p->{relative}) {
134	wakaba	1.2	$p->{-parent}->append_text (join '//', @{$o->{link}->{dest}->{page_name_relative}});
135	wakaba	1.1	} else {
136	wakaba	1.2	$p->{-parent}->append_text (join '//', @{$o->{link}->{dest}->{page_name}});
137	wakaba	1.1	}
138
139			FormattingRule:
140			@Category[list]:page-link
141			@Name: page-title
142			@Description:
143			@@@:Title of the WikiPage
144			@@lang:en
145			@Parameter:
146			@@Name:relative
147			@@Type:boolean
148			@@Default:"0"
149			@@Description:
150			@@@@:Whether relative to "this" page
151			@@@lang:en
152			@Formatting:
153			__ATTRTEXT:%relative__;
154			if (defined $o->{link}->{dest}->{page_title}) {
155	wakaba	1.3	## ISSUE: Is this work now?
156	wakaba	1.1	$p->{-parent}->append_text ($o->{link}->{dest}->{page_title});
157			} elsif ($p->{relative}) {
158	wakaba	1.3	$p->{-parent}->append_text (join '//', @{$o->{link}->{dest}->{page_name_relative}});
159	wakaba	1.1	} else {
160	wakaba	1.3	$p->{-parent}->append_text (join '//', @{$o->{link}->{dest}->{page_name}});
161	wakaba	1.1	}
162
163			FormattingRule:
164			@Category[list]:page-link
165			@Name:page-headline
166			@Description:
167			@@@:Headline summary of the WikiPage
168			@@lang:en
169			@Formatting:
170			$p->{-parent}->append_text
171	wakaba	1.3	(__FUNCPACK__->get_headsummary
172			## TODO:
173			($o->{link}->{dest}->{page_name},
174			wiki => $o->{wiki}));
175	wakaba	1.1
176	wakaba	1.2	FormattingRule:
177			@Category[list]: form-input
178			@Name: wpp--next-anchor-index
179			@Description:
180			@@@: Next "anchor index" number
181			@@lang: en
182			@Formatting:
183			my $page = $o->{wiki}->{var}->{page};
184	wakaba	1.3	my $content;
185			try {
186			$content = $o->{wiki}->{db}->get (content => $page);
187			} catch SuikaWiki::DB::Util::Error with {
188			$content = undef;
189			};
190	wakaba	1.2
191			## Get Format Handler
192			my $format = SuikaWiki::Plugin->module_package ('WikiFormat')
193			->handler (\$content,
194			wiki => $o->{wiki});
195
196			$p->{-parent}->append_text ($format->next_index_for_anchor
197			(\$content, wiki => $o->{wiki},
198			page => $page));
199
200	wakaba	1.1	Function:
201			@Name: unixtime_to_string
202			@Description
203			@@@:
204			Convert internal date-time format to other (possibly human readable)
205			format.
206			\
207			Note: Currently, only one fixed format is supported, whilst
208			future version is expected to support highly customizable
209			formatting supported by Message::Field::Date.
210			@@lang:en
211			@Main:
212			my @date = gmtime shift;
213			sprintf '%04d-%02d-%02d %02d:%02d:%02d +00:00',
214			$date[5] + 1900,
215			$date[4] + 1,
216			@date[3,2,1,0];
217
218			Function:
219	wakaba	1.3	@Name: get_headsummary
220	wakaba	1.1	@Description:
221	wakaba	1.3	@@@: Returns headline summary
222	wakaba	1.1	@@lang:en
223			@Main:
224	wakaba	1.3	my (undef, $page, %opt) = @_;
225			$page \|\|= $opt{wiki}->{var}->{page};
226
227			my $s;
228			try {
229			if ($opt{wiki}->{db}->exist (wpp__headsummary => $page)) {
230			$s = $opt{wiki}->{db}->get (wpp__headsummary => $page);
231			} else {
232			my $content = $opt{wiki}->{db}->get (content => $page);
233
234			## Get Format Handler
235			my $format = SuikaWiki::Plugin->module_package ('WikiFormat')
236			->handler (\$content,
237			wiki => $opt{wiki});
238			$s = $format->headsummary (\$content, wiki => $opt{wiki});
239
240			$s =~ tr/\x0D//d;
241			if (length ($s) > 500) {
242			$s = substr ($s, 0, 500);
243			$s =~ s/[^\x09\x0A\x20-\x7E]+$//;
244			$s .= '...';
245			}
246			if ($s =~ /^([^\x0A]*(?:\x0A+[^\x0A]+){0,9})/) {
247			$s = $1;
248			}
249			$s =~ s/[\x09\x0A\x20]+/\x20/gs;
250			$s =~ s/\([^\(\)]+\)//g;
251			$s =~ s/\[[^\[\]]+\]//g;
252			$s =~ s/>>[0-9]+//g;
253			$s =~ s/<[^<>]+>//g;
254			$s =~ s/{[^{}]+}//g;
255			$s =~ s/20[0-9][0-9]-[01][0-9]-[0-3][0-9][T\x20][0-2][0-9]:[0-5][0-9]:[0-5][0-9](?:\s[+-][0-9][0-9]:[0-9][0-9])?//g;
256			$s =~ s/ [Aa]n? / /g;
257	wakaba	1.1	$s =~ s/ [Aa]t / @ /g;
258			$s =~ s/ [Tt]he / /g;
259			$s =~ s/,? and / & /g;
260			$s =~ s!,? or ! / !g;
261			$s =~ s! not !n't !g;
262			$s =~ s! (?:i\|ha)s !'s !g;
263			$s =~ s! are !'re !g;
264			$s =~ s! [Ww]ith(in\|out)? !' w/'.substr ($1,0,1).' '!ge;
265	wakaba	1.3	$s =~ s![.,]\x20?$!!g;
266			$s =~ s/\x20+/\x20/g;
267			if (length ($s) > 400) {
268			$s = substr ($s, 0, 400);
269			$s =~ s/[^\x20-\x7E]+$//s; # Remove broken EUC-JP char
270			$s .= '...';
271			}
272			$opt{wiki}->{db}->set (wpp__headsummary => $page => $s);
273			}
274			} catch SuikaWiki::DB::Util::Error with {
275			$s = undef;
276			};
277			return $s;
278	wakaba	1.1
279			ViewFragment:
280			@Name: ws--post-content
281			@Description:
282			@@@: After content body -- last modified date and time of the WikiPage
283			@@lang:en
284			@Order: 800
285			@Formatting:
286			%block (
287			id => last-modified,
288			content => {%res(name=>{LastModified=});%last-modified;}p,
289			);
290
291			Resource:
292			@LastModified=:
293			@@@:
294			Last modified:
295			@@lang: en