ikiwiki-upstream - Unnamed repository; edit this file to name it for gitweb.

path: root/doc/examples/softwaresite/news

diff options

Diffstat (limited to 'doc/examples/softwaresite/news')

0 files changed, 0 insertions, 0 deletions

n class="hl sng">"attachment", call => \&checkconfig);

    hook(type => "formbuilder_setup", id => "attachment", call => \&formbuilder_setup);

    hook(type => "formbuilder", id => "attachment", call => \&formbuilder);

    IkiWiki::loadplugin("filecheck");

}

sub getsetup () {

return

plugin => {

            safe => 1,

            rebuild => 0,

allowed_attachments => {

            type => "pagespec",

            example => "virusfree() and mimetype(image/*) and maxsize(50kb)",

            description => "enhanced PageSpec specifying what attachments are allowed",

            link => "ikiwiki/PageSpec/attachment",

            safe => 1,

            rebuild => 0,

virus_checker => {

            type => "string",

            example => "clamdscan -",

            description => "virus checker program (reads STDIN, returns nonzero if virus found)",

            safe => 0, # executed

            rebuild => 0,

}

sub check_canattach ($$;$) {

    my $session=shift;

    my $dest=shift; # where it's going to be put, under the srcdir

    my $file=shift; # the path to the attachment currently

# Don't allow an attachment to be uploaded with the same name as an

# existing page.

    if (exists $IkiWiki::pagesources{$dest} &&

        $IkiWiki::pagesources{$dest} ne $dest) {

        error(sprintf(gettext("there is already a page named %s"), $dest));

}

# Use a special pagespec to test that the attachment is valid.

    my $allowed=1;

    if (defined $config{allowed_attachments} &&

        length $config{allowed_attachments}) {

        $allowed=pagespec_match($dest,

            $config{allowed_attachments},

            file => $file,

            user => $session->param("name"),

            ip => $ENV{REMOTE_ADDR},

);

}

    if (! $allowed) {

        error(gettext("prohibited by allowed_attachments")." ($allowed)");

}

else {

        return 1;

}

sub checkconfig () {

    $config{cgi_disable_uploads}=0;

}

sub formbuilder_setup (@) {

    my %params=@_;

    my $form=$params{form};

    my $q=$params{cgi};

    if (defined $form->field("do") && ($form->field("do") eq "edit" ||

        $form->field("do") eq "create")) {

# Add attachment field, set type to multipart.

        $form->enctype(&CGI::MULTIPART);

        $form->field(name => 'attachment', type => 'file');

# These buttons are not put in the usual place, so

# are not added to the normal formbuilder button list.

        $form->tmpl_param("field-upload" => '<input name="_submit" type="submit" value="Upload Attachment" />');

        $form->tmpl_param("field-link" => '<input name="_submit" type="submit" value="Insert Links" />');

# Add the toggle javascript; the attachments interface uses

# it to toggle visibility.

        require IkiWiki::Plugin::toggle;

        $form->tmpl_param("javascript" => IkiWiki::Plugin::toggle::include_javascript($params{page}, 1));

# Start with the attachments interface toggled invisible,

# but if it was used, keep it open.

        if ($form->submitted ne "Upload Attachment" &&

            (! defined $q->param("attachment_select") ||

            ! length $q->param("attachment_select"))) {

            $form->tmpl_param("attachments-class" => "toggleable");

}

else {

            $form->tmpl_param("attachments-class" => "toggleable-open");

}

sub formbuilder (@) {

    my %params=@_;

    my $form=$params{form};

    my $q=$params{cgi};

    return if ! defined $form->field("do") || ($form->field("do") ne "edit" && $form->field("do") ne "create") ;

    my $filename=$q->param('attachment');

    if (defined $filename && length $filename &&

            ($form->submitted eq "Upload Attachment" || $form->submitted eq "Save Page")) {

        my $session=$params{session};

# This is an (apparently undocumented) way to get the name

# of the temp file that CGI writes the upload to.

        my $tempfile=$q->tmpFileName($filename);

        if (! defined $tempfile || ! length $tempfile) {

# perl 5.8 needs an alternative, awful method

            if ($q =~ /HASH/ && exists $q->{'.tmpfiles'}) {

                foreach my $key (keys(%{$q->{'.tmpfiles'}})) {

                    $tempfile=$q->tmpFileName(\$key);

                    last if defined $tempfile && length $tempfile;

}

            if (! defined $tempfile || ! length $tempfile) {

                error("CGI::tmpFileName failed to return the uploaded file name");

}

        $filename=linkpage(IkiWiki::possibly_foolish_untaint(

                attachment_location($form->field('page')).

                IkiWiki::basename($filename)));

        if (IkiWiki::file_pruned($filename, $config{srcdir})) {

            error(gettext("bad attachment filename"));

}

# Check that the user is allowed to edit a page with the

# name of the attachment.

        IkiWiki::check_canedit($filename, $q, $session, 1);

# And that the attachment itself is acceptable.

        check_canattach($session, $filename, $tempfile);

# Needed for fast_file_copy and for rendering below.

        require IkiWiki::Render;

# Move the attachment into place.

# Try to use a fast rename; fall back to copying.

        IkiWiki::prep_writefile($filename, $config{srcdir});

        unlink($config{srcdir}."/".$filename);

        if (rename($tempfile, $config{srcdir}."/".$filename)) {

# The temp file has tight permissions; loosen up.

            chmod(0666 & ~umask, $config{srcdir}."/".$filename);

}

else {

            my $fh=$q->upload('attachment');

            if (! defined $fh || ! ref $fh) {

# needed by old CGI versions

                $fh=$q->param('attachment');

                if (! defined $fh || ! ref $fh) {

# even that doesn't always work,

# fall back to opening the tempfile

                    $fh=undef;

                    open($fh, "<", $tempfile) || error("failed to open \"$tempfile\": $!");

}

            binmode($fh);

            writefile($filename, $config{srcdir}, undef, 1, sub {

                IkiWiki::fast_file_copy($tempfile, $filename, $fh, @_);

});

}

# Check the attachment in and trigger a wiki refresh.

        if ($config{rcs}) {

            IkiWiki::rcs_add($filename);

IkiWiki::disable_commit_hook();

            IkiWiki::rcs_commit($filename, gettext("attachment upload"),

                IkiWiki::rcs_prepedit($filename),

                $session->param("name"), $ENV{REMOTE_ADDR});

IkiWiki::enable_commit_hook();

IkiWiki::rcs_update();

}

IkiWiki::refresh();

IkiWiki::saveindex();

}

    elsif ($form->submitted eq "Insert Links") {

        my $page=quotemeta($q->param("page"));

        my $add="";

        foreach my $f ($q->param("attachment_select")) {

            $f=~s/^$page\///;

            $add.="[[$f]]\n";

}

        $form->field(name => 'editcontent',

            value => $form->field('editcontent')."\n\n".$add,

            force => 1) if length $add;

}

# Generate the attachment list only after having added any new

# attachments.

    $form->tmpl_param("attachment_list" => [attachment_list($form->field('page'))]);

}

sub attachment_location ($) {

    my $page=shift;

# Put the attachment in a subdir of the page it's attached

# to, unless that page is an "index" page.

    $page=~s/(^|\/)index//;

    $page.="/" if length $page;

    return $page;

}

sub attachment_list ($) {

    my $page=shift;

    my $loc=attachment_location($page);

    my @ret;

    foreach my $f (values %pagesources) {

        if (! defined pagetype($f) &&

            $f=~m/^\Q$loc\E[^\/]+$/ &&

            -e "$config{srcdir}/$f") {

            push @ret, {

                "field-select" => '<input type="checkbox" name="attachment_select" value="'.$f.'" />',

                link => htmllink($page, $page, $f, noimageinline => 1),

                size => IkiWiki::Plugin::filecheck::humansize((stat(_))[7]),

                mtime => displaytime($IkiWiki::pagemtime{$f}),

};

}

# Sort newer attachments to the top of the list, so a newly-added

# attachment appears just before the form used to add it.

    return sort { $b->{mtime_raw} <=> $a->{mtime_raw} || $a->{link} cmp $b->{link} } @ret;

}


context:
space:
mode: