SuikaWiki/Plugin/WikiRead.wp2

#?SuikaWikiConfig/2.0

Plugin:
  @Name: WikiRead
  @Description:
    @@@: Showing WikiPage content
    @@lang:en
  @License: %%Perl%%
  @Author:
    @@Name:
      @@@@: Wakaba
      @@@lang:ja
      @@@script:Latn
    @@Mail[list]: w@suika.fam.cx
  @Date.RCS:
    $Date: 2004/02/18 07:18:30 $
  @RequiredModule[list]:
    SuikaWiki::Format::Definition
  @RequiredPlugin[list]:
    WikiFormat
    WikiView
    WikiStruct
    WikiLinking
    HTML
    SuikaWiki09
  @Use:
    require SuikaWiki::Format::Definition;
    use Message::Util::Error;

ViewDefinition:
  @Mode: read
  @Condition:
    @@http-method[list]:
      GET
      HEAD
      POST
  @Description:
    @@@: Show WikiPage content as whole
    @@lang: en
  @template:
    @@http-status-code: 200
    @@media-type: text/html
    @@use-media-type-charset: 1
    @@expires: %%view%%
    @@body:
        %html-document (
          title => {%res (name => {View:WebPageTitle});}p,
          link-meta => {%template (name => links);}p,
          content => {
            %template (
              name => ws--page,
              -content => {
                %block (
                  class => "bodytext",
                  content => {%template (name => wr--read-body);}p,
                );
              },
            );
          }p,
        );

ViewFragment:
  @Template[list]:wr--read-body
  @Order: 0
  @Description:
    @@@: "Read" mode body -- WikiPage main content
    @@lang:en
  @Formatting:
    %read (comment);

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

FormattingRule:
  @Category[list]: view
  @Name: read
  @Description:
    @@@:
      Show the WikiPage to be "read"
    @@lang: en
  @Parameter:
    @@Name: page
    @@Type: WikiName
    @@Default: (current)
    @@Description:
      @@@@: WikiPage shown
      @@@lang:en
  @Parameter:
    @@Name: comment
    @@Type: boolean
    @@Default: {0}
    @@Description:
      @@@@: Append comment form
      @@@lang:en
  @Parameter:
    @@Name: IsFragment
    @@Type: boolean
    @@Default: (auto)
    @@Description:
      @@@@:
        Specify whether convertion result should be "fragment" format.
        (For example, "text/html" fragment will not have "html" element
        as the root element.)
      @@@lang: en
  @Parameter:
    @@Name: Name
    @@Type: product-name-token
    @@Default: (auto)
    @@Description:
      @@@@:
        Media type name (product style).
      @@@lang: en
  @Parameter:
    @@Name: return-type
    @@Type: token
    @@Default: (default)
    @@Description:
      @@@@:
        Select how the content converted to be returned.
      \
        (default): Result is appended to the parent node.
      \
        'ToString': Result is returned as a Perl string.
      \
        'ToOctetStream': Result is returned as a Perl byte string.
      \
        Nothing is returned in case convertion to specified returning method
        is not defined by the Format definition.
  @Parameter:
    @@Name: Type
    @@Type: internet-media-type-subtype
    @@Default: (auto)
    @@Description:
      @@@@:
        Internet media type (type/subtype pair) to which content should be
        converted.
      \
        Note that media type parameters cannot be specified here.
        Way to specify them are under consideration.
      \
        Neither Type nor Name is specified, defaulted to
        (Type => {text/html}, IsFragment => 1).
  @Parameter:
    @@Name: Version
    @@Type: product-version-token
    @@Default: (auto)
    @@Description:
      @@@@:
        Media type version (product style).
      \
        Name parameter should also be specified, otherwise Version makes
        no mean.
  @Parameter:
    @@Name: when-no-converter
    @@Type: token
    @@Default: "exception"
    @@Description:
      @@@@:
        Specify how behave if Converter not found.
      \
        'exception': Throw an exception.
      \
        '406': Turn to -wf--converter-not-found mode.
      \
        'ignore': Ignore.  Returned value is not defined.
  @Formatting:
    __ATTRTEXT:%page__;__ATTRTEXT:%comment__;
    my $page = $o->{wiki}->name ($p->{page} || $o->{wiki}->{var}->{page});
    my $content;
    my $content_prop;
    try {
      $content = $o->{wiki}->{db}->get (content => $page);
      $content_prop = $o->{wiki}->{db}->get (content_prop => $page);
    } catch SuikaWiki::DB::Util::Error with {
      my $err = shift;
      $err->throw if $err->{-type} eq 'ERROR_REPORTED';
      $content = undef;
    };
    
    my %param;
    if ($p->{Type} or $p->{Name}) {
      for (qw/Type Name Version IsFragment return_type/) {
        $param{$_} = $p->{$_};
      }
      ## TODO: Type_param
    } else {
      %param = (Type => 'text/html', IsFragment => 1);
    }
    
    my $return;
    try {
      my $format = SuikaWiki::Plugin->module_package ('WikiFormat')
                                    ->handler (\$content,
                                               content_prop => $content_prop,
                                               o => $o, wiki => $o->{wiki});
      $return = $format->convert
                           (\$content, %param,
                            -parent => $p->{-parent},
                            content_prop => $content_prop,
                            o => $o, page => $page,
                            -with_annotation_input => $p->{comment});
    } catch SuikaWiki::Format::Definition::error with {
      my $err = shift;

        if ($p->{when_no_converter} eq '406') {
          SuikaWiki::Plugin->module_package ('Error')
                           ->report_error_simple
                               ($o->{wiki}, WikiFormat => $err->text);
          $o->{wiki}->view_in_mode (mode => '-wf--converter-not-found',
                                    method => 'GET');
          throw SuikaWiki::View::Implementation::error
                -type => 'ERROR_REPORTED';
        } elsif ($p->{when_no_converter} ne 'ignore') {
          $err->throw;
        }
    };
    if ($p->{return_type} eq 'ToString' or
        $p->{return_type} eq 'ToOctetStream') {
      $p->{-parent}->append_new_node (type => '#xml', value => $return);
    }

ViewFragment:
  @Name: links
  @Description:
    @@@: Link to read mode of the WikiPage
    @@lang:en
  @Formatting:
    %link-wiki(mode=>read,rel=>view,class=>wiki-cmd,
               description=>{%res(name=>{Link:View:Description});}p,up-to-date); 

ViewFragment:
  @Name: navbar
  @Description:
    @@@: Link to read mode of the WikiPage
  @Order: 0
  @Formatting:
    %link-to-wikipage (
      rel => view,
      mode => read,
      up-to-date,
      label => {%link-to-it (
        class => wiki-cmd,
        label => {%res(name=>ViewThisPage);}p,
        description => {%res(name=>ViewThisPageLong);}p,
      );},
    ); 

Resource:
  @Link:View:Description:
    @@@: Show this WikiPage in reading mode
    @@lang:en
  @Mode:read:
    @@@: Browsing
    @@lang: en
  @ViewThisPage:
    @@@: View
    @@lang:en
  @ViewThisPageLong:
    @@@: Show latest version of this WikiPage
    @@lang:en
  @View:WebPageTitle:
    @@@: %page-name;
    @@lang:en


1	wakaba	1.1	#?SuikaWikiConfig/2.0
2
3			Plugin:
4			@Name: WikiRead
5			@Description:
6			@@@: Showing WikiPage content
7			@@lang:en
8	wakaba	1.9	@License: %%Perl%%
9	wakaba	1.1	@Author:
10			@@Name:
11			@@@@: Wakaba
12			@@@lang:ja
13			@@@script:Latn
14			@@Mail[list]: w@suika.fam.cx
15	wakaba	1.9	@Date.RCS:
16			$Date: 2004/02/18 07:18:30 $
17	wakaba	1.2	@RequiredModule[list]:
18	wakaba	1.3	SuikaWiki::Format::Definition
19	wakaba	1.2	@RequiredPlugin[list]:
20	wakaba	1.5	WikiFormat
21	wakaba	1.2	WikiView
22			WikiStruct
23			WikiLinking
24			HTML
25			SuikaWiki09
26	wakaba	1.3	@Use:
27			require SuikaWiki::Format::Definition;
28	wakaba	1.6	use Message::Util::Error;
29	wakaba	1.1
30			ViewDefinition:
31			@Mode: read
32			@Condition:
33			@@http-method[list]:
34			GET
35			HEAD
36	wakaba	1.7	POST
37	wakaba	1.1	@Description:
38			@@@: Show WikiPage content as whole
39			@@lang: en
40			@template:
41			@@http-status-code: 200
42			@@media-type: text/html
43			@@use-media-type-charset: 1
44			@@expires: %%view%%
45			@@body:
46			%html-document (
47	wakaba	1.2	title => {%res (name => {View:WebPageTitle});}p,
48			link-meta => {%template (name => links);}p,
49	wakaba	1.1	content => {
50			%template (
51			name => ws--page,
52			-content => {
53			%block (
54	wakaba	1.3	class => "bodytext",
55	wakaba	1.2	content => {%template (name => wr--read-body);}p,
56	wakaba	1.1	);
57			},
58			);
59			}p,
60			);
61
62	wakaba	1.2	ViewFragment:
63			@Template[list]:wr--read-body
64			@Order: 0
65			@Description:
66			@@@: "Read" mode body -- WikiPage main content
67			@@lang:en
68			@Formatting:
69			%read (comment);
70
71	wakaba	1.1	PluginConst:
72			@NS_XHTML1:
73			http://www.w3.org/1999/xhtml
74
75			FormattingRule:
76			@Category[list]: view
77			@Name: read
78			@Description:
79			@@@:
80			Show the WikiPage to be "read"
81			@@lang: en
82			@Parameter:
83			@@Name: page
84			@@Type: WikiName
85			@@Default: (current)
86			@@Description:
87			@@@@: WikiPage shown
88			@@@lang:en
89			@Parameter:
90			@@Name: comment
91			@@Type: boolean
92			@@Default: {0}
93			@@Description:
94			@@@@: Append comment form
95			@@@lang:en
96	wakaba	1.7	@Parameter:
97			@@Name: IsFragment
98			@@Type: boolean
99			@@Default: (auto)
100			@@Description:
101			@@@@:
102			Specify whether convertion result should be "fragment" format.
103			(For example, "text/html" fragment will not have "html" element
104			as the root element.)
105			@@@lang: en
106			@Parameter:
107			@@Name: Name
108			@@Type: product-name-token
109			@@Default: (auto)
110			@@Description:
111			@@@@:
112			Media type name (product style).
113			@@@lang: en
114			@Parameter:
115			@@Name: return-type
116			@@Type: token
117			@@Default: (default)
118			@@Description:
119			@@@@:
120			Select how the content converted to be returned.
121			\
122			(default): Result is appended to the parent node.
123			\
124			'ToString': Result is returned as a Perl string.
125			\
126			'ToOctetStream': Result is returned as a Perl byte string.
127			\
128			Nothing is returned in case convertion to specified returning method
129			is not defined by the Format definition.
130			@Parameter:
131			@@Name: Type
132			@@Type: internet-media-type-subtype
133			@@Default: (auto)
134			@@Description:
135			@@@@:
136			Internet media type (type/subtype pair) to which content should be
137			converted.
138			\
139			Note that media type parameters cannot be specified here.
140			Way to specify them are under consideration.
141			\
142			Neither Type nor Name is specified, defaulted to
143			(Type => {text/html}, IsFragment => 1).
144			@Parameter:
145			@@Name: Version
146			@@Type: product-version-token
147			@@Default: (auto)
148			@@Description:
149			@@@@:
150			Media type version (product style).
151			\
152			Name parameter should also be specified, otherwise Version makes
153			no mean.
154			@Parameter:
155			@@Name: when-no-converter
156			@@Type: token
157			@@Default: "exception"
158			@@Description:
159			@@@@:
160			Specify how behave if Converter not found.
161			\
162			'exception': Throw an exception.
163			\
164			'406': Turn to -wf--converter-not-found mode.
165			\
166			'ignore': Ignore. Returned value is not defined.
167	wakaba	1.1	@Formatting:
168	wakaba	1.3	__ATTRTEXT:%page__;__ATTRTEXT:%comment__;
169	wakaba	1.7	my $page = $o->{wiki}->name ($p->{page} \|\| $o->{wiki}->{var}->{page});
170	wakaba	1.6	my $content;
171	wakaba	1.9	my $content_prop;
172	wakaba	1.6	try {
173			$content = $o->{wiki}->{db}->get (content => $page);
174	wakaba	1.9	$content_prop = $o->{wiki}->{db}->get (content_prop => $page);
175	wakaba	1.6	} catch SuikaWiki::DB::Util::Error with {
176	wakaba	1.8	my $err = shift;
177			$err->throw if $err->{-type} eq 'ERROR_REPORTED';
178	wakaba	1.6	$content = undef;
179			};
180	wakaba	1.4
181	wakaba	1.7	my %param;
182			if ($p->{Type} or $p->{Name}) {
183			for (qw/Type Name Version IsFragment return_type/) {
184			$param{$_} = $p->{$_};
185			}
186			## TODO: Type_param
187			} else {
188			%param = (Type => 'text/html', IsFragment => 1);
189			}
190
191			my $return;
192			try {
193			my $format = SuikaWiki::Plugin->module_package ('WikiFormat')
194			->handler (\$content,
195	wakaba	1.9	content_prop => $content_prop,
196	wakaba	1.7	o => $o, wiki => $o->{wiki});
197			$return = $format->convert
198			(\$content, %param,
199			-parent => $p->{-parent},
200	wakaba	1.9	content_prop => $content_prop,
201	wakaba	1.7	o => $o, page => $page,
202			-with_annotation_input => $p->{comment});
203			} catch SuikaWiki::Format::Definition::error with {
204			my $err = shift;
205
206			if ($p->{when_no_converter} eq '406') {
207			SuikaWiki::Plugin->module_package ('Error')
208			->report_error_simple
209			($o->{wiki}, WikiFormat => $err->text);
210			$o->{wiki}->view_in_mode (mode => '-wf--converter-not-found',
211			method => 'GET');
212			throw SuikaWiki::View::Implementation::error
213			-type => 'ERROR_REPORTED';
214			} elsif ($p->{when_no_converter} ne 'ignore') {
215			$err->throw;
216			}
217			};
218			if ($p->{return_type} eq 'ToString' or
219			$p->{return_type} eq 'ToOctetStream') {
220			$p->{-parent}->append_new_node (type => '#xml', value => $return);
221			}
222	wakaba	1.1
223			ViewFragment:
224			@Name: links
225			@Description:
226			@@@: Link to read mode of the WikiPage
227			@@lang:en
228			@Formatting:
229			%link-wiki(mode=>read,rel=>view,class=>wiki-cmd,
230	wakaba	1.4	description=>{%res(name=>{Link:View:Description});}p,up-to-date);
231	wakaba	1.1
232			ViewFragment:
233			@Name: navbar
234			@Description:
235			@@@: Link to read mode of the WikiPage
236			@Order: 0
237			@Formatting:
238	wakaba	1.3	%link-to-wikipage (
239			rel => view,
240			mode => read,
241			up-to-date,
242			label => {%link-to-it (
243			class => wiki-cmd,
244			label => {%res(name=>ViewThisPage);}p,
245			description => {%res(name=>ViewThisPageLong);}p,
246			);},
247			);
248	wakaba	1.1
249			Resource:
250			@Link:View:Description:
251			@@@: Show this WikiPage in reading mode
252			@@lang:en
253	wakaba	1.7	@Mode:read:
254			@@@: Browsing
255			@@lang: en
256	wakaba	1.1	@ViewThisPage:
257			@@@: View
258			@@lang:en
259			@ViewThisPageLong:
260			@@@: Show latest version of this WikiPage
261			@@lang:en
262			@View:WebPageTitle:
263			@@@: %page-name;
264			@@lang:en
265
266