1 package BSE::Edit::Article;
3 use base qw(BSE::Edit::Base);
4 use BSE::Util::Tags qw(tag_error_img tag_article tag_object);
5 use BSE::Util::SQL qw(now_sqldate now_sqldatetime);
7 use BSE::Util::HTML qw(:default popup_menu);
9 use BSE::CfgInfo qw(custom_class admin_base_url cfg_image_dir cfg_dist_image_uri cfg_image_uri);
10 use BSE::Util::Iterate;
12 use BSE::Util::ContentType qw(content_type);
13 use BSE::Regen 'generate_article';
14 use DevHelp::Date qw(dh_parse_date dh_parse_sql_date);
15 use List::Util qw(first);
16 use constant MAX_FILE_DISPLAYNAME_LENGTH => 255;
17 use constant ARTICLE_CUSTOM_FIELDS_CFG => "article custom fields";
19 our $VERSION = "1.051";
23 BSE::Edit::Article - editing functionality for BSE articles
27 Provides the base article editing functionality.
29 This is badly organized and documented.
38 my ($self, $req) = @_;
41 # AJAX/Prototype request
42 return $req->json_content
46 message => "Access forbidden: user not logged on",
48 error_code => "LOGON",
52 elsif ($req->cgi->param('_service')) {
55 content => 'Access Forbidden: login timed out',
57 "Status: 403", # forbidden
62 BSE::Template->get_refresh($req->url('logon'), $req->cfg);
66 sub article_dispatch {
67 my ($self, $req, $article, $articles) = @_;
69 BSE::Permissions->check_logon($req)
70 or return $self->not_logged_on($req);
74 my %actions = $self->article_actions;
75 for my $check (keys %actions) {
76 if ($cgi->param($check) || $cgi->param("$check.x")) {
83 ($action, @extraargs) = $self->other_article_actions($cgi);
86 my $method = $actions{$action};
87 return $self->$method($req, $article, $articles, @extraargs);
90 sub noarticle_dispatch {
91 my ($self, $req, $articles) = @_;
93 BSE::Permissions->check_logon($req)
94 or return BSE::Template->get_refresh($req->url('logon'), $req->cfg);
97 my $article = $self->_dummy_article($req, $articles, \$mymsg);
99 require BSE::Edit::Site;
100 my $site = BSE::Edit::Site->new(cfg=>$req->cfg, db=> BSE::DB->single);
101 return $site->edit_sections($req, $articles, $mymsg);
106 my %actions = $self->noarticle_actions;
107 for my $check (keys %actions) {
108 if ($cgi->param($check) || $cgi->param("$check.x")) {
113 my $method = $actions{$action};
114 return $self->$method($req, $article, $articles);
117 sub article_actions {
124 add_stepkid => 'add_stepkid',
125 del_stepkid => 'del_stepkid',
126 save_stepkids => 'save_stepkids',
127 add_stepparent => 'add_stepparent',
128 del_stepparent => 'del_stepparent',
129 save_stepparents => 'save_stepparents',
130 artimg => 'save_image_changes',
131 addimg => 'add_image',
132 a_edit_image => 'req_edit_image',
133 a_save_image => 'req_save_image',
134 a_order_images => 'req_order_images',
136 showimages => 'show_images',
137 process => 'save_image_changes',
138 removeimg => 'remove_img',
139 moveimgup => 'move_img_up',
140 moveimgdown => 'move_img_down',
141 filelist => 'filelist',
142 fileadd => 'fileadd',
143 fileswap => 'fileswap',
144 filedel => 'filedel',
145 filesave => 'filesave',
146 a_edit_file => 'req_edit_file',
147 a_save_file => 'req_save_file',
150 a_thumb => 'req_thumb',
151 a_ajax_get => 'req_ajax_get',
152 a_ajax_save_body => 'req_ajax_save_body',
153 a_ajax_set => 'req_ajax_set',
154 a_filemeta => 'req_filemeta',
155 a_csrfp => 'req_csrfp',
156 a_tree => 'req_tree',
157 a_article => 'req_article',
158 a_config => 'req_config',
159 a_restepkid => 'req_restepkid',
163 sub other_article_actions {
164 my ($self, $cgi) = @_;
166 for my $param ($cgi->param) {
167 if ($param =~ /^removeimg_(\d+)(\.x)?$/) {
168 return ('removeimg', $1 );
175 sub noarticle_actions {
180 a_csrfp => 'req_csrfp',
181 a_config => 'req_config',
186 my ($self, $parentid, $articles) = @_;
188 if ($parentid == -1) {
192 title=>'All Sections',
199 return $articles->getByPkey($parentid);
204 my ($object, $args) = @_;
206 my $value = $object->{$args};
207 defined $value or $value = '';
208 if ($value =~ /\cJ/ && $value =~ /\cM/) {
215 my ($object, $args) = @_;
217 my $value = $object->{$args};
218 defined $value or $value = '';
219 if ($value =~ /\cJ/ && $value =~ /\cM/) {
222 escape_html($value, '<>&"');
226 my ($level, $cfg) = @_;
228 escape_html($cfg->entry('level names', $level, 'Article'));
237 sub reparent_updown {
241 sub should_be_catalog {
242 my ($self, $article, $parent, $articles) = @_;
244 if ($article->{parentid} && (!$parent || $parent->{id} != $article->{parentid})) {
245 $parent = $articles->getByPkey($article->{id});
248 my $shopid = $self->cfg->entryErr('articles', 'shop');
250 return $article->{parentid} && $parent &&
251 ($article->{parentid} == $shopid ||
252 $parent->{generator} eq 'BSE::Generate::Catalog');
255 sub possible_parents {
256 my ($self, $article, $articles, $req) = @_;
261 my $shopid = $self->cfg->entryErr('articles', 'shop');
262 my @parents = $articles->getBy('level', $article->{level}-1);
263 @parents = grep { $_->{generator} eq 'BSE::Generate::Article'
264 && $_->{id} != $shopid } @parents;
266 # user can only select parent they can add to
267 @parents = grep $req->user_can('edit_add_child', $_), @parents;
269 @values = ( map {$_->{id}} @parents );
270 %labels = ( map { $_->{id} => "$_->{title} ($_->{id})" } @parents );
272 if ($article->{level} == 1 && $req->user_can('edit_add_child')) {
274 $labels{-1} = "No parent - this is a section";
277 if ($article->{id} && $self->reparent_updown($article)) {
278 # we also list the siblings and grandparent (if any)
279 my @siblings = grep $_->{id} != $article->{id} && $_->{id} != $shopid,
280 $articles->getBy(parentid => $article->{parentid});
281 @siblings = grep $req->user_can('edit_add_child', $_), @siblings;
282 push @values, map $_->{id}, @siblings;
283 @labels{map $_->{id}, @siblings} =
284 map { "-- move down a level -- $_->{title} ($_->{id})" } @siblings;
286 if ($article->{parentid} != -1) {
287 my $parent = $articles->getByPkey($article->{parentid});
288 if ($parent->{parentid} != -1) {
289 my $gparent = $articles->getByPkey($parent->{parentid});
290 if ($req->user_can('edit_add_child', $gparent)) {
291 push @values, $gparent->{id};
292 $labels{$gparent->{id}} =
293 "-- move up a level -- $gparent->{title} ($gparent->{id})";
297 if ($req->user_can('edit_add_child')) {
299 $labels{-1} = $req->catmsg("msg:bse/admin/edit/uplabelsect");
305 return (\@values, \%labels);
309 my ($self, $article, $articles, $cgi, $req, $what) = @_;
311 if ($what eq 'listed') {
312 my @values = qw(0 1);
313 my %labels = ( 0=>"No", 1=>"Yes");
314 if ($article->{level} <= 2) {
315 $labels{2} = "In Sections, but not menu";
319 $labels{2} = "In content, but not menus";
322 return popup_menu(-name=>'listed',
325 -default=>$article->{listed});
328 my ($values, $labels) = $self->possible_parents($article, $articles, $req);
330 if (defined $article->{parentid}) {
331 $html = popup_menu(-name=>'parentid',
334 -default => $article->{parentid},
338 $html = popup_menu(-name=>'parentid',
344 # munge the html - we display a default value, so we need to wrap the
345 # default <select /> around this one
346 $html =~ s!^<select[^>]+>|</select>!!gi;
352 my ($arg, $acts, $funcname, $templater) = @_;
353 my ($func, $args) = split ' ', $arg, 2;
354 return $templater->perform($acts, $func, $args) ? 'checked' : '';
357 sub iter_get_images {
358 my ($self, $article) = @_;
360 $article->{id} or return;
361 $self->get_images($article);
365 my ($article, $articles) = @_;
368 $article->{id} or return;
369 if (UNIVERSAL::isa($article, 'BSE::TB::Article')) {
370 @children = $article->children;
372 elsif ($article->{id}) {
373 @children = $articles->children($article->{id});
376 return sort { $b->{displayOrder} <=> $a->{displayOrder} } @children;
379 sub tag_if_have_child_type {
380 my ($level, $cfg) = @_;
382 defined $cfg->entry("level names", $level+1);
386 my ($args, $acts, $isname, $templater) = @_;
388 my ($func, $funcargs) = split ' ', $args, 2;
389 return $templater->perform($acts, $func, $funcargs) ? 'Yes' : 'No';
392 sub default_template {
393 my ($self, $article, $cfg, $templates) = @_;
395 if ($article->{parentid}) {
396 my $template = $cfg->entry("children of $article->{parentid}", "template");
398 if $template && grep $_ eq $template, @$templates;
400 if ($article->{level}) {
401 my $template = $cfg->entry("level $article->{level}", "template");
403 if $template && grep $_ eq $template, @$templates;
405 return $templates->[0];
409 my ($self, $article, $cfg, $cgi) = @_;
411 my @templates = sort { $a->{name} cmp $b->{name} } $self->templates_long($article);
413 if ($article->{template} && grep $_->{name} eq $article->{template}, @templates) {
414 $default = $article->{template};
417 my @template_names = map $_->{name}, @templates;
418 $default = $self->default_template($article, $cfg, \@template_names);
425 $_->{name} eq $_->{description}
427 : "$_->{description} ($_->{name})"
430 return popup_menu(-name => 'template',
431 -values => [ map $_->{name}, @templates ],
433 -default => $default,
438 my ($self, $article) = @_;
441 my $imagedir = cfg_image_dir($self->cfg);
442 if (opendir TITLE_IMAGES, "$imagedir/titles") {
444 grep -f "$imagedir/titles/$_" && /\.(gif|jpeg|jpg|png)$/i,
445 readdir TITLE_IMAGES;
446 closedir TITLE_IMAGES;
452 sub tag_title_images {
453 my ($self, $article, $cfg, $cgi) = @_;
455 my @images = $self->title_images($article);
456 my @values = ( '', @images );
457 my %labels = ( '' => 'None', map { $_ => $_ } @images );
459 popup_menu(-name=>'titleImage',
462 -default=>$article->{id} ? $article->{titleImage} : '',
466 sub base_template_dirs {
471 my ($self, $article) = @_;
473 my @dirs = $self->base_template_dirs;
474 if (my $parentid = $article->{parentid}) {
475 my $section = "children of $parentid";
476 if (my $dirs = $self->cfg->entry($section, 'template_dirs')) {
477 push @dirs, split /,/, $dirs;
480 if (my $id = $article->{id}) {
481 my $section = "article $id";
482 if (my $dirs = $self->{cfg}->entry($section, 'template_dirs')) {
483 push @dirs, split /,/, $dirs;
486 if ($article->{level}) {
487 push @dirs, $article->{level};
488 my $dirs = $self->{cfg}->entry("level $article->{level}", 'template_dirs');
489 push @dirs, split /,/, $dirs if $dirs;
496 my ($self, $article) = @_;
498 my @dirs = $self->template_dirs($article);
500 my @basedirs = BSE::Template->template_dirs($self->{cfg});
501 for my $basedir (@basedirs) {
502 for my $dir (@dirs) {
503 my $path = File::Spec->catdir($basedir, $dir);
505 if (opendir TEMPLATE_DIR, $path) {
506 push(@templates, sort map "$dir/$_",
507 grep -f "$path/$_" && /\.(tmpl|html)$/i, readdir TEMPLATE_DIR);
508 closedir TEMPLATE_DIR;
514 # eliminate any dups, and order it nicely
516 @templates = sort { lc($a) cmp lc($b) }
517 grep !$seen{$_}++, @templates;
519 return (@templates, $self->extra_templates($article));
522 sub extra_templates {
523 my ($self, $article) = @_;
525 my $basedir = $self->{cfg}->entryVar('paths', 'templates');
527 if (my $id = $article->{id}) {
528 push @templates, 'index.tmpl'
529 if $id == 1 && -f "$basedir/index.html";
530 push @templates, 'index2.tmpl'
531 if $id == 2 && -f "$basedir/index2.html";
532 my $shopid = $self->{cfg}->entryErr('articles', 'shop');
533 push @templates, "shop_sect.tmpl"
534 if $id == $shopid && -f "$basedir/shop_sect.tmpl";
535 my $section = "article $id";
536 my $extras = $self->{cfg}->entry($section, 'extra_templates');
537 push @templates, grep /\.(tmpl|html)$/i, split /,/, $extras
545 my ($self, $articles) = @_;
547 return $articles->categories;
553 return '' unless $article->{id} && $article->{id} != -1;
555 <a href="$ENV{SCRIPT_NAME}?id=$article->{parentid}">Edit parent</a> |
562 return unless $article->{id} && $article->{id} > 0;
566 sub _load_step_kids {
567 my ($article, $step_kids) = @_;
569 require BSE::TB::OtherParents;
570 my @stepkids = BSE::TB::OtherParents->getBy(parentId=>$article->{id}) if $article->{id};
571 %$step_kids = map { $_->{childId} => $_ } @stepkids;
572 $step_kids->{loaded} = 1;
575 sub tag_if_step_kid {
576 my ($article, $allkids, $rallkid_index, $step_kids) = @_;
578 _load_step_kids($article, $step_kids) unless $step_kids->{loaded};
580 my $kid = $allkids->[$$rallkid_index]
582 exists $step_kids->{$kid->{id}};
586 my ($article, $allkids, $rallkid_index, $step_kids, $arg) = @_;
588 _load_step_kids($article, $step_kids) unless $step_kids->{loaded};
590 my $kid = $allkids->[$$rallkid_index]
592 my $step_kid = $step_kids->{$kid->{id}}
595 #print STDERR "found kid (want $arg): ", Dumper($kid), Dumper($step_kid);
596 escape_html($step_kid->{$arg});
599 sub tag_move_stepkid {
600 my ($self, $cgi, $req, $article, $allkids, $rallkids_index, $arg,
601 $acts, $funcname, $templater) = @_;
603 $req->user_can(edit_reorder_children => $article)
606 @$allkids > 1 or return '';
608 my ($img_prefix, $urladd) = DevHelp::Tags->get_parms($arg, $acts, $templater);
609 $img_prefix = '' unless defined $img_prefix;
610 $urladd = '' unless defined $urladd;
612 my $cgi_uri = $self->{cfg}->entry('uri', 'cgi', '/cgi-bin');
613 my $url = $ENV{SCRIPT_NAME} . "?id=$article->{id}";
614 if ($cgi->param('_t')) {
615 $url .= "&_t=".$cgi->param('_t');
620 if ($$rallkids_index < $#$allkids) {
621 $down_url = "$cgi_uri/admin/move.pl?stepparent=$article->{id}&d=swap&id=$allkids->[$$rallkids_index]{id}&other=$allkids->[$$rallkids_index+1]{id}";
624 if ($$rallkids_index > 0) {
625 $up_url = "$cgi_uri/admin/move.pl?stepparent=$article->{id}&d=swap&id=$allkids->[$$rallkids_index]{id}&other=$allkids->[$$rallkids_index-1]{id}";
628 return make_arrows($req->cfg, $down_url, $up_url, $url, $img_prefix);
631 sub possible_stepkids {
632 my ($req, $article, $articles, $stepkids) = @_;
634 $req->user_can(edit_stepkid_add => $article)
640 my @possible = sort { lc $a->{title} cmp lc $b->{title} }
641 $article->possible_stepchildren;
642 if ($req->access_control && $req->cfg->entry('basic', 'access_filter_steps', 0)) {
643 @possible = grep $req->user_can(edit_stepparent_add => $_->{id}), @possible;
648 sub tag_possible_stepkids {
649 my ($step_kids, $req, $article, $possstepkids, $articles, $cgi) = @_;
651 _load_step_kids($article, $step_kids) unless $step_kids->{loaded};
652 @$possstepkids = possible_stepkids($req, $article, $articles, $step_kids)
653 unless @$possstepkids;
654 my %labels = map { $_->{id} => "$_->{title} ($_->{id})" } @$possstepkids;
656 popup_menu(-name=>'stepkid',
657 -values=> [ map $_->{id}, @$possstepkids ],
658 -labels => \%labels);
661 sub tag_if_possible_stepkids {
662 my ($step_kids, $req, $article, $possstepkids, $articles, $cgi) = @_;
664 _load_step_kids($article, $step_kids) unless $step_kids->{loaded};
665 @$possstepkids = possible_stepkids($req, $article, $articles, $step_kids)
666 unless @$possstepkids;
671 sub iter_get_stepparents {
674 return unless $article->{id} && $article->{id} > 0;
676 require BSE::TB::OtherParents;
677 BSE::TB::OtherParents->getBy(childId=>$article->{id});
680 sub tag_ifStepParents {
681 my ($args, $acts, $funcname, $templater) = @_;
683 return $templater->perform($acts, 'ifStepparents', '');
686 sub tag_stepparent_targ {
687 my ($article, $targs, $rindex, $arg) = @_;
689 if ($article->{id} && $article->{id} > 0 && !@$targs) {
690 @$targs = $article->step_parents;
692 escape_html($targs->[$$rindex]{$arg});
695 sub tag_move_stepparent {
696 my ($self, $cgi, $req, $article, $stepparents, $rindex, $arg,
697 $acts, $funcname, $templater) = @_;
699 $req->user_can(edit_reorder_stepparents => $article)
702 @$stepparents > 1 or return '';
704 my ($img_prefix, $urladd) = DevHelp::Tags->get_parms($arg, $acts, $templater);
705 $img_prefix = '' unless defined $img_prefix;
706 $urladd = '' unless defined $urladd;
708 my $cgi_uri = $self->{cfg}->entry('uri', 'cgi', '/cgi-bin');
709 my $images_uri = cfg_dist_image_uri();
711 my $url = $ENV{SCRIPT_NAME} . "?id=$article->{id}";
712 if ($cgi->param('_t')) {
713 $url .= "&_t=".$cgi->param('_t');
716 $url .= "#stepparents";
717 my $blank = qq!<img src="$images_uri/trans_pixel.gif" width="17" height="13" border="0" align="absbottom" alt="" />!;
719 if ($$rindex < $#$stepparents) {
720 $down_url = "$cgi_uri/admin/move.pl?stepchild=$article->{id}&id=$stepparents->[$$rindex]{parentId}&d=swap&other=$stepparents->[$$rindex+1]{parentId}";
724 $up_url = "$cgi_uri/admin/move.pl?stepchild=$article->{id}&id=$stepparents->[$$rindex]{parentId}&d=swap&other=$stepparents->[$$rindex-1]{parentId}";
727 return make_arrows($req->cfg, $down_url, $up_url, $url, $img_prefix);
730 sub _stepparent_possibles {
731 my ($req, $article, $articles, $targs) = @_;
733 $req->user_can(edit_stepparent_add => $article)
739 @$targs = $article->step_parents unless @$targs;
740 my %targs = map { $_->{id}, 1 } @$targs;
741 my @possibles = $article->possible_stepparents;
742 if ($req->access_control && $req->cfg->entry('basic', 'access_filter_steps', 0)) {
743 @possibles = grep $req->user_can(edit_stepkid_add => $_->{id}), @possibles;
745 @possibles = sort { lc $a->{title} cmp lc $b->{title} } @possibles;
750 sub tag_if_stepparent_possibles {
751 my ($req, $article, $articles, $targs, $possibles) = @_;
753 if ($article->{id} && $article->{id} > 0 && !@$possibles) {
754 @$possibles = _stepparent_possibles($req, $article, $articles, $targs);
759 sub tag_stepparent_possibles {
760 my ($cgi, $req, $article, $articles, $targs, $possibles) = @_;
762 if ($article->{id} && $article->{id} > 0 && !@$possibles) {
763 @$possibles = _stepparent_possibles($req, $article, $articles, $targs);
765 popup_menu(-name=>'stepparent',
766 -values => [ map $_->{id}, @$possibles ],
767 -labels => { map { $_->{id}, "$_->{title} ($_->{id})" }
772 my ($self, $article) = @_;
774 return $self->get_files($article);
778 my ($self, $article) = @_;
780 return unless $article->{id} && $article->{id} > 0;
782 return $article->files;
785 sub tag_edit_parent {
788 return '' unless $article->{id} && $article->{id} != -1;
791 <a href="$ENV{SCRIPT_NAME}?id=$article->{parentid}">Edit parent</a> |
795 sub tag_if_children {
796 my ($args, $acts, $funcname, $templater) = @_;
798 return $templater->perform($acts, 'ifChildren', '');
802 my ($self, $req, $article, $kids, $rindex, $arg,
803 $acts, $funcname, $templater) = @_;
805 $req->user_can('edit_reorder_children', $article)
808 @$kids > 1 or return '';
810 $$rindex >=0 && $$rindex < @$kids
811 or return '** movechild can only be used in the children iterator **';
813 my ($img_prefix, $urladd) = DevHelp::Tags->get_parms($arg, $acts, $templater);
814 $img_prefix = '' unless defined $img_prefix;
815 $urladd = '' unless defined $urladd;
817 my $cgi_uri = $self->{cfg}->entry('uri', 'cgi', '/cgi-bin');
818 my $images_uri = cfg_dist_image_uri();
819 my $urlbase = admin_base_url($req->cfg);
820 my $refresh_url = "$urlbase$ENV{SCRIPT_NAME}?id=$article->{id}";
821 my $t = $req->cgi->param('_t');
822 if ($t && $t =~ /^\w+$/) {
823 $refresh_url .= "&_t=$t";
826 $refresh_url .= $urladd;
828 my $id = $kids->[$$rindex]{id};
830 if ($$rindex < $#$kids) {
831 $down_url = "$cgi_uri/admin/move.pl?id=$id&d=down&edit=1&all=1";
835 $up_url = "$cgi_uri/admin/move.pl?id=$id&d=up&edit=1&all=1"
838 return make_arrows($req->cfg, $down_url, $up_url, $refresh_url, $img_prefix);
842 my ($self, $articles, $article) = @_;
844 my @cats = $self->categories($articles);
846 my %labels = map { $_->{id}, $_->{name} } @cats;
848 return popup_menu(-name => 'category',
849 -values => [ map $_->{id}, @cats ],
851 -default => $article->{category});
855 my ($cfg, $article, $args, $acts, $funcname, $templater) = @_;
856 my ($which, $name) = split / /, $args, 2;
860 && ($gen_class = $templater->perform($acts, $which, 'generator'))) {
861 eval "use $gen_class";
863 my $gen = $gen_class->new(top => $article, cfg => $cfg);
864 my $link = $gen->edit_link($templater->perform($acts, $which, 'id'));
865 return qq!<a href="$link">$name</a>!;
872 my ($req, $article, $rindex, $images, $arg,
873 $acts, $funcname, $templater) = @_;
875 $req->user_can(edit_images_reorder => $article)
878 @$images > 1 or return '';
880 $$rindex >= 0 && $$rindex < @$images
881 or return '** imgmove can only be used in image iterator **';
883 my ($img_prefix, $urladd) = DevHelp::Tags->get_parms($arg, $acts, $templater);
884 $img_prefix = '' unless defined $img_prefix;
885 $urladd = '' unless defined $urladd;
887 my $urlbase = admin_base_url($req->cfg);
888 my $url = "$urlbase$ENV{SCRIPT_NAME}?id=$article->{id}";
889 my $t = $req->cgi->param('_t');
890 if ($t && $t =~ /^\w+$/) {
895 my $image = $images->[$$rindex];
896 my $csrfp = $req->get_csrf_token("admin_move_image");
897 my $baseurl = "$ENV{SCRIPT_NAME}?id=$article->{id}&imageid=$image->{id}&";
898 $baseurl .= "_csrfp=$csrfp&";
900 if ($$rindex < $#$images) {
901 $down_url = $baseurl . "moveimgdown=1";
905 $up_url = $baseurl . "moveimgup=1";
907 return make_arrows($req->cfg, $down_url, $up_url, $url, $img_prefix);
911 my ($self, $req, $article, $files, $rindex, $arg,
912 $acts, $funcname, $templater) = @_;
914 $req->user_can('edit_files_reorder', $article)
917 @$files > 1 or return '';
919 my ($img_prefix, $urladd) = DevHelp::Tags->get_parms($arg, $acts, $templater);
920 $img_prefix = '' unless defined $img_prefix;
921 $urladd = '' unless defined $urladd;
923 $$rindex >= 0 && $$rindex < @$files
924 or return '** movefiles can only be used in the files iterator **';
926 my $urlbase = admin_base_url($req->cfg);
927 my $url = "$urlbase$ENV{SCRIPT_NAME}?id=$article->{id}$urladd";
928 my $t = $req->cgi->param('_t');
929 if ($t && $t =~ /^\w+$/) {
934 my $csrfp = $req->get_csrf_token("admin_move_file");
935 my $baseurl = "$ENV{SCRIPT_NAME}?fileswap=1&id=$article->{id}&";
936 $baseurl .= "_csrfp=$csrfp&";
937 if ($$rindex < $#$files) {
938 $down_url = $baseurl . "file1=$files->[$$rindex]{id}&file2=$files->[$$rindex+1]{id}";
942 $up_url = $baseurl . "file1=$files->[$$rindex]{id}&file2=$files->[$$rindex-1]{id}";
945 return make_arrows($req->cfg, $down_url, $up_url, $url, $img_prefix);
949 my ($article, $cgi, $args, $acts, $funcname, $templater) = @_;
951 my ($col, $func, $funcargs) = split ' ', $args, 3;
952 my $value = $cgi->param($col);
953 if (defined $value) {
954 return escape_html($value);
958 return $templater->perform($acts, $func, $funcargs);
961 $value = $article->{$args};
962 defined $value or $value = '';
963 return escape_html($value);
968 sub iter_admin_users {
969 require BSE::TB::AdminUsers;
971 BSE::TB::AdminUsers->all;
974 sub iter_admin_groups {
975 require BSE::TB::AdminGroups;
977 BSE::TB::AdminGroups->all;
980 sub tag_if_field_perm {
981 my ($req, $article, $field) = @_;
983 unless ($field =~ /^\w+$/) {
984 print STDERR "Bad fieldname '$field'\n";
987 if ($article->{id}) {
988 return $req->user_can("edit_field_edit_$field", $article);
991 #print STDERR "adding, always successful\n";
997 my ($self, $req, $article, $args, $acts, $funcname, $templater) = @_;
999 my ($col, $func, $funcargs) = split ' ', $args, 3;
1000 if ($article->{id}) {
1002 return $templater->perform($acts, $func, $funcargs);
1005 my $value = $article->{$args};
1006 defined $value or $value = '';
1007 return escape_html($value, '<>&"');
1011 my $value = $self->default_value($req, $article, $col);
1012 defined $value or $value = '';
1013 return escape_html($value, '<>&"');
1023 sub tag_if_flag_set {
1024 my ($article, $arg, $acts, $funcname, $templater) = @_;
1026 my @args = DevHelp::Tags->get_parms($arg, $acts, $templater);
1029 return index($article->{flags}, $args[0]) >= 0;
1033 my ($article, $articles) = @_;
1036 my $temp = $article;
1037 defined($temp->{parentid}) or return;
1038 while ($temp->{parentid} > 0
1039 and my $crumb = $articles->getByPkey($temp->{parentid})) {
1040 unshift @crumbs, $crumb;
1048 my ($args, $acts, $funcname, $templater) = @_;
1050 exists $acts->{$args} or return "** need an article name **";
1051 my $generator = $templater->perform($acts, $args, 'generator');
1053 $generator =~ /^(?:BSE::)?Generate::(\w+)$/
1054 or return "** invalid generator $generator **";
1059 sub _get_thumbs_class {
1062 $self->{cfg}->entry('editor', 'allow_thumb', 0)
1065 my $class = $self->{cfg}->entry('editor', 'thumbs_class')
1068 (my $filename = "$class.pm") =~ s!::!/!g;
1069 eval { require $filename; };
1071 print STDERR "** Error loading thumbs_class $class ($filename): $@\n";
1075 eval { $obj = $class->new($self->{cfg}) };
1077 print STDERR "** Error creating thumbs objects $class: $@\n";
1084 sub tag_thumbimage {
1085 my ($cfg, $thumbs_obj, $current_image, $args) = @_;
1087 $thumbs_obj or return '';
1089 $$current_image or return '** no current image **';
1091 my $imagedir = cfg_image_dir($cfg);
1093 my $filename = "$imagedir/$$current_image->{image}";
1094 -e $filename or return "** image file missing **";
1096 defined $args && $args =~ /\S/
1097 or $args = "editor";
1099 my $image = $$current_image;
1100 return $image->thumb
1108 sub tag_file_display {
1109 my ($self, $files, $file_index) = @_;
1111 $$file_index >= 0 && $$file_index < @$files
1112 or return "* file_display only usable inside a files iterator *";
1113 my $file = $files->[$$file_index];
1115 my $disp_type = $self->cfg->entry("editor", "file_display", "");
1117 return $file->inline
1120 field => $disp_type,
1125 my ($self, $cfg, $rcurrent, $args) = @_;
1130 my ($align, $rest) = split ' ', $args, 2;
1132 if ($align && exists $im->{$align}) {
1133 if ($align eq 'src') {
1134 return escape_html($im->image_url($self->{cfg}));
1137 return escape_html($im->{$align});
1141 return $im->formatted
1151 my ($self, $article) = @_;
1156 return $article->tag_objects;
1159 my %base_custom_validation =
1220 require DevHelp::Validate;
1221 DevHelp::Validate->import;
1222 return DevHelp::Validate::dh_configure_fields
1224 \%base_custom_validation,
1226 ARTICLE_CUSTOM_FIELDS_CFG,
1227 BSE::DB->single->dbh,
1231 sub _custom_fields {
1234 my $fields = $self->custom_fields;
1236 for my $key (keys %$fields) {
1237 $fields->{$key}{description}
1238 and $active{$key} = $fields->{$key};
1245 my ($self, $acts, $request, $article, $articles, $msg, $errors) = @_;
1247 my $cgi = $request->cgi;
1248 my $show_full = $cgi->param('f_showfull');
1249 my $if_error = $msg || ($errors && keys %$errors) || $request->cgi->param("_e");
1250 #$msg ||= join "\n", map escape_html($_), $cgi->param('message'), $cgi->param('m');
1251 $msg .= $request->message($errors);
1253 if ($article->{id}) {
1254 if ($article->{parentid} > 0) {
1255 $parent = $article->parent;
1258 $parent = { title=>"No parent - this is a section", id=>-1 };
1262 $parent = { title=>"How did we get here?", id=>0 };
1264 $request->set_article(article => $article);
1265 $request->set_variable(ifnew => !$article->{id});
1266 my $cfg = $self->{cfg};
1267 my $mbcs = $cfg->entry('html', 'mbcs', 0);
1268 my $tag_hash = $mbcs ? \&tag_hash_mbcs : \&tag_hash;
1269 my $thumbs_obj_real = $self->_get_thumbs_class();
1270 my $thumbs_obj = $show_full ? undef : $thumbs_obj_real;
1281 my $stepparent_index;
1282 my @stepparent_targs;
1283 my @stepparentpossibles;
1288 my $it = BSE::Util::Iterate->new;
1289 my $ito = BSE::Util::Iterate::Objects->new;
1290 my $ita = BSE::Util::Iterate::Article->new(req => $request);
1292 my $custom = $self->_custom_fields;
1293 # only return the fields that are defined
1294 $request->set_variable(custom => $custom);
1295 $request->set_variable(errors => $errors || {});
1299 $request->admin_tags,
1300 article => sub { tag_article($article, $cfg, $_[0]) },
1301 old => [ \&tag_old, $article, $cgi ],
1302 default => [ \&tag_default, $self, $request, $article ],
1303 articleType => [ \&tag_art_type, $article->{level}, $cfg ],
1304 parentType => [ \&tag_art_type, $article->{level}-1, $cfg ],
1305 ifNew => [ \&tag_if_new, $article ],
1306 list => [ \&tag_list, $self, $article, $articles, $cgi, $request ],
1307 script => $ENV{SCRIPT_NAME},
1308 level => $article->{level},
1309 checked => \&tag_checked,
1311 ([ \&iter_get_images, $self, $article ], 'image', 'images', \@images,
1312 \$image_index, undef, \$current_image),
1313 image => [ tag_image => $self, $cfg, \$current_image ],
1314 thumbimage => [ \&tag_thumbimage, $cfg, $thumbs_obj, \$current_image ],
1315 ifThumbs => defined($thumbs_obj),
1316 ifCanThumbs => defined($thumbs_obj_real),
1317 imgmove => [ \&tag_imgmove, $request, $article, \$image_index, \@images ],
1319 ifError => $if_error,
1322 code => [ \&iter_get_kids, $article, $articles ],
1324 plural => 'children',
1326 index => \$child_index,
1328 ifchildren => \&tag_if_children,
1329 childtype => [ \&tag_art_type, $article->{level}+1, $cfg ],
1330 ifHaveChildType => [ \&tag_if_have_child_type, $article->{level}, $cfg ],
1331 movechild => [ \&tag_movechild, $self, $request, $article, \@children,
1334 templates => [ \&tag_templates, $self, $article, $cfg, $cgi ],
1335 titleImages => [ \&tag_title_images, $self, $article, $cfg, $cgi ],
1336 editParent => [ \&tag_edit_parent, $article ],
1339 code => [ \&iter_allkids, $article ],
1343 index => \$allkid_index,
1346 [ \&tag_if_step_kid, $article, \@allkids, \$allkid_index, \%stepkids ],
1347 stepkid => [ \&tag_step_kid, $article, \@allkids, \$allkid_index,
1350 [ \&tag_move_stepkid, $self, $cgi, $request, $article, \@allkids,
1352 possible_stepkids =>
1353 [ \&tag_possible_stepkids, \%stepkids, $request, $article,
1354 \@possstepkids, $articles, $cgi ],
1356 [ \&tag_if_possible_stepkids, \%stepkids, $request, $article,
1357 \@possstepkids, $articles, $cgi ],
1360 code => [ \&iter_get_stepparents, $article ],
1361 single => 'stepparent',
1362 plural => 'stepparents',
1363 data => \@stepparents,
1364 index => \$stepparent_index,
1366 ifStepParents => \&tag_ifStepParents,
1368 [ \&tag_stepparent_targ, $article, \@stepparent_targs,
1369 \$stepparent_index ],
1371 [ \&tag_move_stepparent, $self, $cgi, $request, $article, \@stepparents,
1372 \$stepparent_index ],
1373 ifStepparentPossibles =>
1374 [ \&tag_if_stepparent_possibles, $request, $article, $articles,
1375 \@stepparent_targs, \@stepparentpossibles, ],
1376 stepparent_possibles =>
1377 [ \&tag_stepparent_possibles, $cgi, $request, $article, $articles,
1378 \@stepparent_targs, \@stepparentpossibles, ],
1381 code => [ iter_files => $self, $article ],
1385 index => \$file_index,
1388 [ \&tag_movefiles, $self, $request, $article, \@files, \$file_index ],
1391 code => [ iter_file_metas => $self, \@files, \$file_index ],
1392 plural => "file_metas",
1393 single => "file_meta",
1396 ifFileExists => sub {
1397 @files && $file_index >= 0 && $file_index < @files
1400 return -f ($files[$file_index]->full_filename($cfg));
1402 file_display => [ tag_file_display => $self, \@files, \$file_index ],
1403 DevHelp::Tags->make_iterator2
1404 (\&iter_admin_users, 'iadminuser', 'adminusers'),
1405 DevHelp::Tags->make_iterator2
1406 (\&iter_admin_groups, 'iadmingroup', 'admingroups'),
1407 edit => [ \&tag_edit_link, $cfg, $article ],
1408 error => [ $tag_hash, $errors ],
1409 error_img => [ \&tag_error_img, $cfg, $errors ],
1410 ifFieldPerm => [ \&tag_if_field_perm, $request, $article ],
1411 parent => [ \&tag_article, $parent, $cfg ],
1412 DevHelp::Tags->make_iterator2
1413 ([ \&iter_flags, $self ], 'flag', 'flags' ),
1414 ifFlagSet => [ \&tag_if_flag_set, $article ],
1415 DevHelp::Tags->make_iterator2
1416 ([ \&iter_crumbs, $article, $articles ], 'crumb', 'crumbs' ),
1417 typename => \&tag_typename,
1418 $it->make_iterator([ \&iter_groups, $request ],
1419 'group', 'groups', \@groups, undef, undef,
1421 $it->make_iterator([ iter_image_stores => $self],
1422 'image_store', 'image_stores'),
1423 $it->make_iterator([ iter_file_stores => $self],
1424 'file_store', 'file_stores'),
1425 ifGroupRequired => [ \&tag_ifGroupRequired, $article, \$current_group ],
1426 category => [ tag_category => $self, $articles, $article ],
1431 code => [ iter_tags => $self, $article ],
1436 sub iter_image_stores {
1439 my $mgr = $self->_image_manager;
1441 return map +{ name => $_->name, description => $_->description },
1448 require BSE::TB::ArticleFiles;
1450 return BSE::TB::ArticleFiles->file_manager($self->cfg);
1453 sub iter_file_stores {
1456 require BSE::TB::ArticleFiles;
1457 my $mgr = $self->_file_manager($self->cfg);
1459 return map +{ name => $_->name, description => $_->description },
1466 require BSE::TB::SiteUserGroups;
1467 BSE::TB::SiteUserGroups->admin_and_query_groups($req->cfg);
1470 sub tag_ifGroupRequired {
1471 my ($article, $rgroup) = @_;
1476 $$rgroup or return 0;
1478 $article->is_accessible_to($$rgroup);
1482 my ($self, $article, $cgi) = @_;
1484 my $base = $article->{level};
1485 my $t = $cgi->param('_t');
1486 if ($t && $t =~ /^\w+$/) {
1489 return $self->{cfg}->entry('admin templates', $base,
1490 "admin/edit_$base");
1494 my ($self, $article, $cgi) = @_;
1496 $self->edit_template($article, $cgi);
1500 my ($self, $request, $article, $articles, $msg, $errors) = @_;
1502 my $cgi = $request->cgi;
1504 %acts = $self->low_edit_tags(\%acts, $request, $article, $articles, $msg,
1506 my $template = $article->{id} ?
1507 $self->edit_template($article, $cgi) : $self->add_template($article, $cgi);
1509 return $request->response($template, \%acts);
1513 my ($self, $request, $article, $articles, $msg, $errors) = @_;
1515 return $self->low_edit_form($request, $article, $articles, $msg, $errors);
1518 sub _dummy_article {
1519 my ($self, $req, $articles, $rmsg) = @_;
1522 my $cgi = $req->cgi;
1523 my $parentid = $cgi->param('parentid');
1525 if ($parentid =~ /^\d+$/) {
1526 if (my $parent = $self->get_parent($parentid, $articles)) {
1527 $level = $parent->{level}+1;
1533 elsif ($parentid eq "-1") {
1537 unless (defined $level) {
1538 $level = $cgi->param('level');
1539 undef $level unless defined $level && $level =~ /^\d+$/
1540 && $level > 0 && $level < 100;
1541 defined $level or $level = 3;
1545 my @cols = BSE::TB::Article->columns;
1546 @article{@cols} = ('') x @cols;
1548 $article{parentid} = $parentid;
1549 $article{level} = $level;
1550 $article{body} = '<maximum of 64Kb>';
1551 $article{listed} = 1;
1552 $article{generator} = $self->generator;
1554 my ($values, $labels) = $self->possible_parents(\%article, $articles, $req);
1556 $$rmsg = "You can't add children to any article at that level";
1564 my ($self, $req, $article, $articles, $msg, $errors) = @_;
1566 return $self->low_edit_form($req, $article, $articles, $msg, $errors);
1569 sub generator { 'BSE::Generate::Article' }
1574 my $gen = $self->generator;
1576 ($gen =~ /(\w+)$/)[0] || 'Article';
1579 sub _validate_common {
1580 my ($self, $data, $articles, $errors, $article) = @_;
1582 # if (defined $data->{parentid} && $data->{parentid} =~ /^(?:-1|\d+)$/) {
1583 # unless ($data->{parentid} == -1 or
1584 # $articles->getByPkey($data->{parentid})) {
1585 # $errors->{parentid} = "Selected parent article doesn't exist";
1589 # $errors->{parentid} = "You need to select a valid parent";
1591 if (exists $data->{title} && $data->{title} !~ /\S/) {
1592 $errors->{title} = "Please enter a title";
1595 if (exists $data->{template} && $data->{template} =~ /\.\./) {
1596 $errors->{template} = "Please only select templates from the list provided";
1598 if (exists $data->{linkAlias}
1599 && length $data->{linkAlias}) {
1600 unless ($data->{linkAlias} =~ /\A[a-zA-Z0-9-_]+\z/
1601 && $data->{linkAlias} =~ /[A-Za-z]/) {
1602 $errors->{linkAlias} = "Link alias must contain only alphanumerics and contain at least one letter";
1606 if (defined $data->{category}) {
1607 unless (first { $_->{id} eq $data->{category} } $self->categories($articles)) {
1608 $errors->{category} = "msg:bse/admin/edit/category/unknown";
1612 require DevHelp::Validate;
1613 DevHelp::Validate->import('dh_validate_hash');
1614 dh_validate_hash($data, $errors,
1616 fields => $self->_custom_fields,
1618 dbh => BSE::DB->single->dbh,
1620 $self->cfg, ARTICLE_CUSTOM_FIELDS_CFG);
1624 my ($self, $data, $articles, $errors) = @_;
1626 $self->_validate_common($data, $articles, $errors);
1627 if (!$errors->{linkAlias} && defined $data->{linkAlias} && length $data->{linkAlias}) {
1628 my $other = $articles->getBy(linkAlias => $data->{linkAlias});
1630 and $errors->{linkAlias} =
1631 "Duplicate link alias - already used by article $other->{id}";
1633 custom_class($self->{cfg})
1634 ->article_validate($data, undef, $self->typename, $errors);
1636 return !keys %$errors;
1640 my ($self, $article, $data, $articles, $errors, $ajax) = @_;
1642 $self->_validate_common($data, $articles, $errors, $article);
1643 custom_class($self->{cfg})
1644 ->article_validate($data, $article, $self->typename, $errors);
1646 if (exists $data->{release}) {
1647 if ($ajax && !dh_parse_sql_date($data->{release})
1648 || !$ajax && !dh_parse_date($data->{release})) {
1649 $errors->{release} = "Invalid release date";
1653 if (!$errors->{linkAlias}
1654 && defined $data->{linkAlias}
1655 && length $data->{linkAlias}
1656 && $data->{linkAlias} ne $article->{linkAlias}) {
1657 my $other = $articles->getBy(linkAlias => $data->{linkAlias});
1658 $other && $other->{id} != $article->{id}
1659 and $errors->{linkAlias} = "Duplicate link alias - already used by article $other->{id}";
1662 return !keys %$errors;
1665 sub validate_parent {
1670 my ($self, $req, $data, $articles) = @_;
1672 my $custom = $self->_custom_fields;
1673 for my $key (keys %$custom) {
1674 my ($value) = $req->cgi->param($key);
1675 if (defined $value) {
1676 if ($key =~ /^customDate/) {
1677 require DevHelp::Date;
1679 if (my ($year, $month, $day) =
1680 DevHelp::Date::dh_parse_date($value, \$msg)) {
1681 $data->{$key} = sprintf("%04d-%02d-%02d", $year, $month, $day);
1684 $data->{$key} = undef;
1687 elsif ($key =~ /^customInt/) {
1688 if ($value =~ /\S/) {
1689 $data->{$key} = $value;
1692 $data->{$key} = undef;
1696 $data->{$key} = $value;
1701 custom_class($self->{cfg})
1702 ->article_fill_new($data, $self->typename);
1708 my ($self, $article) = @_;
1710 # check the config for the article and any of its ancestors
1711 my $work_article = $article;
1712 my $path = $self->{cfg}->entry('article uris', $work_article->{id});
1714 last if $work_article->{parentid} == -1;
1715 $work_article = $work_article->parent;
1716 $path = $self->{cfg}->entry('article uris', $work_article->{id});
1718 return $path if $path;
1720 $self->default_link_path($article);
1723 sub default_link_path {
1724 my ($self, $article) = @_;
1726 $self->{cfg}->entry('uri', 'articles', '/a');
1730 my ($self, $article) = @_;
1735 my $title = $article->title;
1736 if ($article->is_dynamic) {
1737 (my $extra = $title) =~ tr/A-Za-z0-9/-/sc;
1738 return "/cgi-bin/page.pl?page=$article->{id}&title=".escape_uri($extra);
1741 my $article_uri = $self->link_path($article);
1742 my $link = "$article_uri/$article->{id}.html";
1743 my $link_titles = $self->{cfg}->entryBool('basic', 'link_titles', 0);
1745 (my $extra = $title) =~ tr/A-Za-z0-9/-/sc;
1746 $link .= "/" . $extra . "_html";
1753 my ($self, $table_object) = @_;
1755 my @columns = $table_object->rowClass->columns;
1761 sub _validate_tags {
1762 my ($self, $tags, $errors) = @_;
1766 for my $tag (@$tags) {
1769 && !BSE::TB::Tags->valid_name($tag, \$error)) {
1770 push @errors, "msg:bse/admin/edit/tags/invalid/$error";
1771 $errors->{tags} = \@errors;
1775 push @errors, undef;
1783 my ($self, $req, $article, $articles) = @_;
1785 $req->check_csrf("admin_add_article")
1786 or return $self->csrf_error($req, undef, "admin_add_article", "Add Article");
1788 my $cgi = $req->cgi;
1790 my $table_object = $self->table_object($articles);
1791 my @columns = $self->save_columns($table_object);
1792 $self->save_thumbnail($cgi, undef, \%data);
1793 for my $name (@columns) {
1794 $data{$name} = $cgi->param($name)
1795 if defined $cgi->param($name);
1797 $data{flags} = join '', sort $cgi->param('flags');
1801 if (!defined $data{parentid} || $data{parentid} eq '') {
1802 $errors{parentid} = "Please select a parent";
1804 elsif ($data{parentid} !~ /^(?:-1|\d+)$/) {
1805 $errors{parentid} = "Invalid parent selection (template bug)";
1807 $self->validate(\%data, $articles, \%errors);
1809 my $save_tags = $cgi->param("_save_tags");
1812 @tags = $cgi->param("tags");
1813 $self->_validate_tags(\@tags, \%errors);
1817 if ($req->is_ajax) {
1818 return $req->json_content
1822 error_code => "FIELD",
1823 message => $req->message(\%errors),
1827 return $self->add_form($req, $article, $articles, $msg, \%errors);
1834 if ($data{parentid} > 0) {
1835 $parent = $articles->getByPkey($data{parentid}) or die;
1836 if ($req->user_can('edit_add_child', $parent)) {
1837 for my $name (@columns) {
1838 if (exists $data{$name} &&
1839 !$req->user_can("edit_add_field_$name", $parent)) {
1840 delete $data{$name};
1845 $parent_msg = "You cannot add a child to that article";
1846 $parent_code = "ACCESS";
1850 if ($req->user_can('edit_add_child')) {
1851 for my $name (@columns) {
1852 if (exists $data{$name} &&
1853 !$req->user_can("edit_add_field_$name")) {
1854 delete $data{$name};
1859 $parent_msg = "You cannot create a top-level article";
1860 $parent_code = "ACCESS";
1864 $self->validate_parent(\%data, $articles, $parent, \$parent_msg)
1865 or $parent_code = "PARENT";
1868 if ($req->is_ajax) {
1869 return $req->json_content
1872 message => $parent_msg,
1873 error_code => $parent_code,
1878 return $self->add_form($req, $article, $articles, $parent_msg);
1882 my $level = $parent ? $parent->{level}+1 : 1;
1883 $data{level} = $level;
1884 $data{displayOrder} = time;
1886 $data{admin} ||= '';
1887 $data{generator} = $self->generator;
1888 $data{lastModified} = now_sqldatetime();
1889 $data{listed} = 1 unless defined $data{listed};
1892 $data{pageTitle} = '' unless defined $data{pageTitle};
1893 my $user = $req->getuser;
1894 $data{createdBy} = $user ? $user->{logon} : '';
1895 $data{lastModifiedBy} = $user ? $user->{logon} : '';
1896 $data{created} = now_sqldatetime();
1899 $data{force_dynamic} = 0;
1900 $data{cached_dynamic} = 0;
1901 $data{inherit_siteuser_rights} = 1;
1904 $data{metaDescription} = '' unless defined $data{metaDescription};
1905 $data{metaKeywords} = '' unless defined $data{metaKeywords};
1908 $self->fill_new_data($req, \%data, $articles);
1909 for my $col (qw(titleImage imagePos template keyword menu titleAlias linkAlias body author summary category)) {
1911 or $data{$col} = $self->default_value($req, \%data, $col);
1914 for my $col (qw/force_dynamic inherit_siteuser_rights/) {
1915 if ($req->user_can("edit_add_field_$col", $parent)
1916 && $cgi->param("save_$col")) {
1917 $data{$col} = $cgi->param($col) ? 1 : 0;
1920 $data{$col} = $self->default_value($req, \%data, $col);
1924 unless ($req->is_ajax) {
1925 for my $col (qw(release expire)) {
1926 $data{$col} = sql_date($data{$col});
1930 # these columns are handled a little differently
1931 for my $col (qw(release expire threshold summaryLength )) {
1933 or $data{$col} = $self->default_value($req, \%data, $col);
1936 my @cols = $table_object->rowClass->columns;
1939 # fill out anything else from defaults
1940 for my $col (@columns) {
1942 or $data{$col} = $self->default_value($req, \%data, $col);
1945 $article = $table_object->add(@data{@cols});
1947 $self->save_new_more($req, $article, \%data);
1949 # we now have an id - generate the links
1951 $article->update_dynamic($self->{cfg});
1952 my $cgi_uri = $self->{cfg}->entry('uri', 'cgi', '/cgi-bin');
1953 $article->setAdmin("$cgi_uri/admin/admin.pl?id=$article->{id}");
1954 $article->setLink($self->make_link($article));
1957 my ($after_id) = $cgi->param("_after");
1958 if (defined $after_id) {
1959 BSE::TB::Articles->reorder_child($article->{parentid}, $article->{id}, $after_id);
1960 # reload, the displayOrder probably changed
1961 $article = $articles->getByPkey($article->{id});
1966 $article->set_tags([ grep /\S/, @tags ], \$error);
1969 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
1971 if ($req->is_ajax) {
1972 return $req->json_content
1976 article => $self->_article_data($req, $article),
1981 my $r = $cgi->param('r');
1983 $r .= ($r =~ /\?/) ? '&' : '?';
1984 $r .= "id=$article->{id}";
1987 $r = admin_base_url($req->cfg) . $article->{admin};
1989 return BSE::Template->get_refresh($r, $self->{cfg});
1993 my ($self, $req, $article, $data) = @_;
1995 if (exists $data->{body}) {
1996 $data->{body} =~ s/\x0D\x0A/\n/g;
1997 $data->{body} =~ tr/\r/\n/;
1999 for my $col (BSE::TB::Article->columns) {
2000 next if $col =~ /^custom/;
2001 $article->{$col} = $data->{$col}
2002 if exists $data->{$col} && $col ne 'id' && $col ne 'parentid';
2004 my $custom = $self->_custom_fields;
2005 for my $key (keys %$custom) {
2006 if (exists $data->{$key}) {
2007 if ($key =~ /^customDate/) {
2008 require DevHelp::Date;
2010 if (my ($year, $month, $day) =
2011 DevHelp::Date::dh_parse_date($data->{$key}, \$msg)) {
2012 $article->set($key, sprintf("%04d-%02d-%02d", $year, $month, $day));
2015 $article->set($key => undef);
2018 elsif ($key =~ /^customInt/) {
2019 if ($data->{$key} =~ /\S/) {
2020 $article->set($key => $data->{$key});
2023 $article->set($key => undef);
2027 $article->set($key => $data->{$key});
2031 custom_class($self->{cfg})
2032 ->article_fill_old($article, $data, $self->typename);
2038 my ($self, $req, $article) = @_;
2040 my $article_data = $article->data_only;
2041 $article_data->{link} = $article->link($req->cfg);
2042 $article_data->{images} =
2044 map $self->_image_data($req->cfg, $_), $article->images
2046 $article_data->{files} =
2048 map $_->data_only, $article->files,
2050 $article_data->{tags} =
2052 $article->tags, # just the names
2055 return $article_data;
2059 my ($self, $req, $article, $data) = @_;
2060 # nothing to do here
2064 my ($self, $req, $article, $data) = @_;
2065 # nothing to do here
2076 ACCESS - user doesn't have access to this article.
2080 LASTMOD - lastModified value doesn't match that in the article
2084 PARENT - invalid parentid specified
2091 my ($self, $req, $article, $articles) = @_;
2093 $req->check_csrf("admin_save_article")
2094 or return $self->csrf_error($req, $article, "admin_save_article", "Save Article");
2096 $req->user_can(edit_save => $article)
2097 or return $self->_service_error
2098 ($req, $article, $articles, "You don't have access to save this article",
2101 my $old_dynamic = $article->is_dynamic;
2102 my $cgi = $req->cgi;
2104 my $table_object = $self->table_object($articles);
2105 my @save_cols = $self->save_columns($table_object);
2106 for my $name (@save_cols) {
2107 $data{$name} = $cgi->param($name)
2108 if defined($cgi->param($name)) and $name ne 'id' && $name ne 'parentid'
2109 && $req->user_can("edit_field_edit_$name", $article);
2113 # checks editor lastModified against record lastModified
2114 if ($self->{cfg}->entry('editor', 'check_modified')) {
2115 if ($article->{lastModified} ne $cgi->param('lastModified')) {
2116 my $whoModified = '';
2117 my $timeModified = ampm_time($article->{lastModified});
2118 if ($article->{lastModifiedBy}) {
2119 $whoModified = "by '$article->{lastModifiedBy}'";
2121 print STDERR "non-matching lastModified, article not saved\n";
2122 my $msg = "Article changes not saved, this article was modified $whoModified at $timeModified since this editor was loaded";
2123 return $self->_service_error($req, $article, $articles, $msg, {}, "LASTMOD");
2128 # possibly this needs tighter error checking
2129 $data{flags} = join '', sort $cgi->param('flags')
2130 if $req->user_can("edit_field_edit_flags", $article);
2132 if (exists $article->{template} &&
2133 $article->{template} =~ m|\.\.|) {
2134 $errors{template} = "Please only select templates from the list provided";
2137 my $save_tags = $cgi->param("_save_tags");
2140 @tags = $cgi->param("tags");
2141 $self->_validate_tags(\@tags, \%errors);
2143 $self->validate_old($article, \%data, $articles, \%errors, scalar $req->is_ajax)
2144 or return $self->_service_error($req, $article, $articles, undef, \%errors, "FIELD");
2145 $self->save_thumbnail($cgi, $article, \%data)
2146 if $req->user_can('edit_field_edit_thumbImage', $article);
2147 if (exists $data{flags} && $data{flags} =~ /D/) {
2148 $article->remove_html;
2150 $self->fill_old_data($req, $article, \%data);
2153 my $newparentid = $cgi->param('parentid');
2155 && $req->user_can('edit_field_edit_parentid', $article)
2156 && $newparentid != $article->{parentid}) {
2159 if ($newparentid == -1) {
2160 require BSE::Edit::Site;
2161 $newparent = BSE::TB::Site->new;
2162 $parent_editor = BSE::Edit::Site->new(cfg => $req->cfg);
2165 $newparent = $articles->getByPkey($newparentid);
2166 ($parent_editor, $newparent) = $self->article_class($newparent, $articles, $req->cfg);
2170 if ($self->can_reparent_to($article, $newparent, $parent_editor, $articles, \$msg)
2171 && $self->reparent($article, $newparentid, $articles, \$msg)) {
2172 # nothing to do here
2175 return $self->_service_error($req, $article, $articles, $msg, {}, "PARENT");
2179 return $self->_service_error($req, $article, $articles, "No such parent article", {}, "PARENT");
2183 $article->{listed} = $cgi->param('listed')
2184 if defined $cgi->param('listed') &&
2185 $req->user_can('edit_field_edit_listed', $article);
2187 if ($req->user_can('edit_field_edit_release', $article)) {
2188 my $release = $cgi->param("release");
2189 if (defined $release && $release =~ /\S/) {
2190 if ($req->is_ajax) {
2191 $article->{release} = $release;
2194 $article->{release} = sql_date($release)
2199 $article->{expire} = sql_date($cgi->param('expire')) || $Constants::D_99
2200 if defined $cgi->param('expire') &&
2201 $req->user_can('edit_field_edit_expire', $article);
2202 for my $col (qw/force_dynamic inherit_siteuser_rights/) {
2203 if ($req->user_can("edit_field_edit_$col", $article)
2204 && $cgi->param("save_$col")) {
2205 $article->{$col} = $cgi->param($col) ? 1 : 0;
2209 $article->mark_modified(actor => $req->getuser || "U");
2211 my @save_group_ids = $cgi->param('save_group_id');
2212 if ($req->user_can('edit_field_edit_group_id')
2213 && @save_group_ids) {
2214 require BSE::TB::SiteUserGroups;
2215 my %groups = map { $_->{id} => $_ }
2216 BSE::TB::SiteUserGroups->admin_and_query_groups($self->{cfg});
2217 my %set = map { $_ => 1 } $cgi->param('group_id');
2218 my %current = map { $_ => 1 } $article->group_ids;
2220 for my $group_id (@save_group_ids) {
2221 $groups{$group_id} or next;
2222 if ($current{$group_id} && !$set{$group_id}) {
2223 $article->remove_group_id($group_id);
2225 elsif (!$current{$group_id} && $set{$group_id}) {
2226 $article->add_group_id($group_id);
2231 my $old_link = $article->{link};
2232 # this need to go last
2233 $article->update_dynamic($self->{cfg});
2234 if (!$self->{cfg}->entry('protect link', $article->{id})) {
2235 my $article_uri = $self->make_link($article);
2236 $article->setLink($article_uri);
2243 $article->set_tags([ grep /\S/, @tags ], \$error);
2248 @extra_regen = $self->update_child_dynamic($article, $articles, $req);
2250 if ($article->is_dynamic || $old_dynamic) {
2251 if (!$old_dynamic and $old_link) {
2252 unlink $article->link_to_filename($self->{cfg}, $old_link);
2254 elsif (!$article->is_dynamic) {
2255 unlink $article->cached_filename($self->{cfg});
2259 my ($after_id) = $cgi->param("_after");
2260 if (defined $after_id) {
2261 BSE::TB::Articles->reorder_child($article->{parentid}, $article->{id}, $after_id);
2262 # reload, the displayOrder probably changed
2263 $article = $articles->getByPkey($article->{id});
2266 if ($Constants::AUTO_GENERATE) {
2267 generate_article($articles, $article);
2268 for my $regen_id (@extra_regen) {
2269 my $regen = $articles->getByPkey($regen_id);
2270 BSE::Regen::generate_low($articles, $regen, $self->{cfg});
2274 $self->save_more($req, $article, \%data);
2276 if ($req->is_ajax) {
2277 return $req->json_content
2281 article => $self->_article_data($req, $article),
2286 return $self->refresh($article, $cgi, undef, 'Article saved');
2289 sub can_reparent_to {
2290 my ($self, $article, $newparent, $parent_editor, $articles, $rmsg) = @_;
2292 my @child_types = $parent_editor->child_types;
2293 if (!grep $_ eq ref $self, @child_types) {
2294 my ($child_type) = (ref $self) =~ /(\w+)$/;
2295 my ($parent_type) = (ref $parent_editor) =~ /(\w+)$/;
2297 $$rmsg = "A $child_type cannot be a child of a $parent_type";
2301 # the article cannot become a child of itself or one of it's
2303 if ($article->{id} == $newparent->id
2304 || $self->is_descendant($article->id, $newparent->id, $articles)) {
2305 $$rmsg = "Cannot become a child of itself or of a descendant";
2309 my $shopid = $self->{cfg}->entryErr('articles', 'shop');
2310 if ($self->shop_article) { # if this article belongs in the shop
2311 unless ($newparent->id == $shopid
2312 || $self->is_descendant($shopid, $newparent->{id}, $articles)) {
2313 $$rmsg = "This article belongs in the shop";
2318 if ($newparent->id == $shopid
2319 || $self->is_descendant($shopid, $newparent->id, $articles)) {
2320 $$rmsg = "This article doesn't belong in the shop";
2328 sub shop_article { 0 }
2330 sub update_child_dynamic {
2331 my ($self, $article, $articles, $req) = @_;
2333 my $cfg = $req->cfg;
2334 my @stack = $article->children;
2337 my $workart = pop @stack;
2338 my $old_dynamic = $workart->is_dynamic; # before update
2339 my $old_link = $workart->{link};
2341 ($editor, $workart) = $self->article_class($workart, $articles, $cfg);
2343 $workart->update_dynamic($cfg);
2344 if ($old_dynamic != $workart->is_dynamic) {
2346 if ($article->{link} && !$cfg->entry('protect link', $workart->{id})) {
2347 my $uri = $editor->make_link($workart);
2348 $workart->setLink($uri);
2350 !$old_dynamic && $old_link
2351 and unlink $workart->link_to_filename($cfg, $old_link);
2352 $workart->is_dynamic
2353 or unlink $workart->cached_filename($cfg);
2356 # save dynamic cache change and link if that changed
2359 push @stack, $workart->children;
2360 push @regen, $workart->{id};
2368 my ($year, $month, $day);
2371 if (($day, $month, $year) = ($str =~ m!(\d+)/(\d+)/(\d+)!)) {
2372 $year += 2000 if $year < 100;
2374 return sprintf("%04d-%02d-%02d", $year, $month, $day);
2380 # Converts 24hr time to 12hr AM/PM time
2383 my ($hour, $minute, $second, $ampm);
2386 if (($hour, $minute, $second) = ($str =~ m!(\d+):(\d+):(\d+)!)) {
2392 $hour = 12 if $hour == 0;
2395 return sprintf("%02d:%02d:%02d $ampm", $hour, $minute, $second);
2402 my ($self, $article, $newparentid, $articles, $rmsg) = @_;
2405 if ($newparentid == -1) {
2409 my $parent = $articles->getByPkey($newparentid);
2411 $$rmsg = "Cannot get new parent article";
2414 $newlevel = $parent->{level} + 1;
2416 # the caller will save this one
2417 $article->{parentid} = $newparentid;
2418 $article->{level} = $newlevel;
2419 $article->{displayOrder} = time;
2421 my @change = ( [ $article->{id}, $newlevel ] );
2423 my $this = shift @change;
2424 my ($art, $level) = @$this;
2426 my @kids = $articles->getBy(parentid=>$art);
2427 push @change, map { [ $_->{id}, $level+1 ] } @kids;
2429 for my $kid (@kids) {
2430 $kid->{level} = $level+1;
2438 # tests if $desc is a descendant of $art
2439 # where both are article ids
2441 my ($self, $art, $desc, $articles) = @_;
2445 my $parent = shift @check;
2446 $parent == $desc and return 1;
2447 my @kids = $articles->getBy(parentid=>$parent);
2448 push @check, map $_->{id}, @kids;
2454 sub save_thumbnail {
2455 my ($self, $cgi, $original, $newdata) = @_;
2457 unless ($original) {
2458 @$newdata{qw/thumbImage thumbWidth thumbHeight/} = ('', 0, 0);
2460 my $imagedir = cfg_image_dir($self->{cfg});
2461 if ($cgi->param('remove_thumb') && $original && $original->{thumbImage}) {
2462 unlink("$imagedir/$original->{thumbImage}");
2463 @$newdata{qw/thumbImage thumbWidth thumbHeight/} = ('', 0, 0);
2465 my $image_name = $cgi->param('thumbnail');
2466 my $image = $cgi->upload('thumbnail');
2467 if ($image_name && -s $image) {
2468 # where to put it...
2470 $image_name =~ /([\w.-]+)$/ and $name = $1;
2471 my $filename = time . "_" . $name;
2475 $filename = time . '_' . $counter . '_' . $name
2476 until sysopen( OUTPUT, "$imagedir/$filename",
2477 O_WRONLY| O_CREAT| O_EXCL)
2478 || ++$counter > 100;
2480 fileno(OUTPUT) or die "Could not open image file: $!";
2486 # read the image in from the browser and output it to our
2488 print STDERR "\$image ",ref $image,"\n";
2490 print OUTPUT $buffer while sysread $image, $buffer, 1024;
2493 or die "Could not close image output file: $!";
2495 require BSE::ImageSize;
2497 if ($original && $original->{thumbImage}) {
2498 #unlink("$imagedir/$original->{thumbImage}");
2500 @$newdata{qw/thumbWidth thumbHeight/} =
2501 BSE::ImageSize::imgsize("$imagedir/$filename");
2502 $newdata->{thumbImage} = $filename;
2507 my ($self, $article) = @_;
2509 my $shopid = $self->{cfg}->entryErr('articles', 'shop');
2510 if ($article && $article->{id} && $article->{id} == $shopid) {
2511 return ( 'BSE::Edit::Catalog' );
2513 return ( 'BSE::Edit::Article' );
2518 Add a step child to an article.
2526 id - parent article id (required)
2530 stepkid - child article id (required)
2534 _after - id of the allkid of id to position the stepkid after
2539 Returns a FIELD error for an invalid stepkid.
2541 Returns an ACCESS error for insufficient access.
2543 Return an ADD error for a general add failure.
2549 relationship: { childId: I<childid>, parentId: I<parentid> }
2557 my ($self, $req, $article, $articles) = @_;
2559 $req->check_csrf("admin_add_stepkid")
2560 or return $self->csrf_error($req, $article, "admin_add_stepkid", "Add Stepkid");
2562 $req->user_can(edit_stepkid_add => $article)
2563 or return $self->_service_error($req, $article, $articles,
2564 "You don't have access to add step children to this article", {}, "ACCESS");
2566 my $cgi = $req->cgi;
2567 require BSE::Admin::StepParents;
2570 my $childId = $cgi->param('stepkid');
2572 or $errors{stepkid} = "No stepkid supplied to add_stepkid";
2573 unless ($errors{stepkid}) {
2575 or $errors{stepkid} = "Invalid stepkid supplied to add_stepkid";
2578 unless ($errors{stepkid}) {
2579 $child = $articles->getByPkey($childId)
2580 or $errors{stepkid} = "Article $childId not found";
2583 and return $self->_service_error
2584 ($req, $article, $articles, $errors{stepkid}, \%errors, "FIELD");
2586 $req->user_can(edit_stepparent_add => $child)
2587 or return $self->_service_error($req, $article, $articles, "You don't have access to add a stepparent to that article", {}, "ACCESS");
2592 my $release = $cgi->param('release');
2593 dh_parse_date($release) or $release = undef;
2594 my $expire = $cgi->param('expire');
2595 dh_parse_date($expire) or $expire = undef;
2598 BSE::Admin::StepParents->add($article, $child, $release, $expire);
2601 return $self->_service_error($req, $article, $articles, $@, {}, "ADD");
2604 my $after_id = $cgi->param("_after");
2605 if (defined $after_id) {
2606 BSE::TB::Articles->reorder_child($article->id, $child->id, $after_id);
2609 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
2611 if ($req->is_ajax) {
2612 return $req->json_content
2615 relationship => $new_entry->data_only,
2619 $self->refresh($article, $cgi, 'step', 'Stepchild added');
2625 Remove a stepkid relationship.
2633 id - parent article id (required)
2637 stepkid - child article id (required)
2641 Returns a FIELD error for an invalid stepkid.
2643 Returns an ACCESS error for insufficient access.
2645 Return a DELETE error for a general delete failure.
2650 my ($self, $req, $article, $articles) = @_;
2652 $req->check_csrf("admin_remove_stepkid")
2653 or return $self->csrf_error($req, $article, "admin_del_stepkid", "Delete Stepkid");
2654 $req->user_can(edit_stepkid_delete => $article)
2655 or return $self->_service_error($req, $article, $articles,
2656 "You don't have access to delete stepchildren from this article", {}, "ACCESS");
2658 my $cgi = $req->cgi;
2661 my $childId = $cgi->param('stepkid');
2663 or $errors{stepkid} = "No stepkid supplied to add_stepkid";
2664 unless ($errors{stepkid}) {
2666 or $errors{stepkid} = "Invalid stepkid supplied to add_stepkid";
2669 unless ($errors{stepkid}) {
2670 $child = $articles->getByPkey($childId)
2671 or $errors{stepkid} = "Article $childId not found";
2674 and return $self->_service_error
2675 ($req, $article, $articles, $errors{stepkid}, \%errors, "FIELD");
2677 $req->user_can(edit_stepparent_delete => $child)
2678 or return _service_error($req, $article, $article, "You cannot remove stepparents from that article", {}, "ACCESS");
2681 require BSE::Admin::StepParents;
2683 BSE::Admin::StepParents->del($article, $child);
2687 return $self->_service_error($req, $article, $articles, $@, {}, "DELETE");
2689 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
2691 if ($req->is_ajax) {
2692 return $req->json_content(success => 1);
2695 return $self->refresh($article, $cgi, 'step', 'Stepchild deleted');
2700 my ($self, $req, $article, $articles) = @_;
2702 $req->check_csrf("admin_save_stepkids")
2703 or return $self->csrf_error($req, $article, "admin_save_stepkids", "Save Stepkids");
2705 $req->user_can(edit_stepkid_save => $article)
2706 or return $self->edit_form($req, $article, $articles,
2707 "No access to save stepkid data for this article");
2709 my $cgi = $req->cgi;
2710 require 'BSE/Admin/StepParents.pm';
2711 my @stepcats = BSE::TB::OtherParents->getBy(parentId=>$article->{id});
2712 my %stepcats = map { $_->{parentId}, $_ } @stepcats;
2713 my %datedefs = ( release => '2000-01-01', expire=>'2999-12-31' );
2714 for my $stepcat (@stepcats) {
2715 $req->user_can(edit_stepparent_save => $stepcat->{childId})
2717 for my $name (qw/release expire/) {
2718 my $date = $cgi->param($name.'_'.$stepcat->{childId});
2719 if (defined $date) {
2721 $date = $datedefs{$name};
2723 elsif (dh_parse_date($date)) {
2724 use BSE::Util::SQL qw/date_to_sql/;
2725 $date = date_to_sql($date);
2728 return $self->refresh($article, $cgi, '', "Invalid date '$date'");
2730 $stepcat->{$name} = $date;
2736 $@ and return $self->refresh($article, $cgi, '', $@);
2738 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
2740 return $self->refresh($article, $cgi, 'step', 'Stepchild information saved');
2745 Moves a stepkid from one parent to another, and sets the order within
2746 that new stepparent.
2754 id - id of the step kid to move (required)
2758 parentid - id of the parent in the stepkid relationship (required)
2762 newparentid - the new parent for the stepkid relationship (optional)
2766 _after - id of the allkid under newparentid (or parentid if
2767 newparentid isn't supplied) to place the stepkid after (0 to place at
2778 NOPARENTID - parentid parameter not supplied
2782 BADPARENTID - non-numeric parentid supplied
2786 NOTFOUND - no stepkid relationship from parentid was found
2790 BADNEWPARENT - newparentid is non-numeric
2794 UNKNOWNNEWPARENT - no article id newparentid found
2798 NEWPARENTDUP - there's already a stepkid relationship between
2806 my ($self, $req, $article, $articles) = @_;
2808 # first, identify the stepkid link
2809 my $cgi = $req->cgi;
2810 require BSE::TB::OtherParents;
2811 my $parentid = $cgi->param("parentid");
2813 or return $self->_service_error($req, $article, $articles, "Missing parentid", {}, "NOPARENTID");
2814 $parentid =~ /^\d+$/
2815 or return $self->_service_error($req, $article, $articles, "Invalid parentid", {}, "BADPARENTID");
2817 my ($step) = BSE::TB::OtherParents->getBy(parentId => $parentid, childId => $article->id)
2818 or return $self->_service_error($req, $article, $articles, "Unknown relationship", {}, "NOTFOUND");
2820 my $newparentid = $cgi->param("newparentid");
2822 $newparentid =~ /^\d+$/
2823 or return $self->_service_error($req, $article, $articles, "Bad new parent id", {}, "BADNEWPARENT");
2824 my $new_parent = BSE::TB::Articles->getByPkey($newparentid)
2825 or return $self->_service_error($req, $article, $articles, "Unknown new parent id", {}, "UNKNOWNNEWPARENT");
2827 BSE::TB::OtherParents->getBy(parentId=>$newparentid, childId=>$article->id)
2828 and return $self->_service_error($req, $article, $articles, "New parent is duplicate", {}, "NEWPARENTDUP");
2830 $step->{parentId} = $newparentid;
2834 my $after_id = $cgi->param("_after");
2835 if (defined $after_id) {
2836 BSE::TB::Articles->reorder_child($step->{parentId}, $article->id, $after_id);
2839 if ($req->is_ajax) {
2840 return $req->json_content
2843 relationshop => $step->data_only,
2847 return $self->refresh($article, $cgi, 'step', "Stepchild moved");
2851 sub add_stepparent {
2852 my ($self, $req, $article, $articles) = @_;
2854 $req->check_csrf("admin_add_stepparent")
2855 or return $self->csrf_error($req, $article, "admin_add_stepparent", "Add Stepparent");
2857 $req->user_can(edit_stepparent_add => $article)
2858 or return $self->edit_form($req, $article, $articles,
2859 "You don't have access to add stepparents to this article");
2861 my $cgi = $req->cgi;
2862 require 'BSE/Admin/StepParents.pm';
2864 my $step_parent_id = $cgi->param('stepparent');
2865 defined($step_parent_id)
2866 or die "No stepparent supplied to add_stepparent";
2867 int($step_parent_id) eq $step_parent_id
2868 or die "Invalid stepcat supplied to add_stepcat";
2869 my $step_parent = $articles->getByPkey($step_parent_id)
2870 or die "Parent $step_parent_id not found\n";
2872 $req->user_can(edit_stepkid_add => $step_parent)
2873 or die "You don't have access to add a stepkid to that article\n";
2875 my $release = $cgi->param('release');
2877 or $release = "01/01/2000";
2878 $release eq '' or dh_parse_date($release)
2879 or die "Invalid release date";
2880 my $expire = $cgi->param('expire');
2882 or $expire = '31/12/2999';
2883 $expire eq '' or dh_parse_date($expire)
2884 or die "Invalid expire data";
2887 BSE::Admin::StepParents->add($step_parent, $article, $release, $expire);
2889 $@ and return $self->refresh($article, $cgi, 'step', $@);
2891 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
2893 return $self->refresh($article, $cgi, 'stepparents', 'Stepparent added');
2896 sub del_stepparent {
2897 my ($self, $req, $article, $articles) = @_;
2899 $req->check_csrf("admin_remove_stepparent")
2900 or return $self->csrf_error($req, $article, "admin_del_stepparent", "Delete Stepparent");
2902 $req->user_can(edit_stepparent_delete => $article)
2903 or return $self->edit_form($req, $article, $articles,
2904 "You cannot remove stepparents from that article");
2906 my $cgi = $req->cgi;
2907 require 'BSE/Admin/StepParents.pm';
2908 my $step_parent_id = $cgi->param('stepparent');
2909 defined($step_parent_id)
2910 or return $self->refresh($article, $cgi, 'stepparents',
2911 "No stepparent supplied to add_stepcat");
2912 int($step_parent_id) eq $step_parent_id
2913 or return $self->refresh($article, $cgi, 'stepparents',
2914 "Invalid stepparent supplied to add_stepparent");
2915 my $step_parent = $articles->getByPkey($step_parent_id)
2916 or return $self->refresh($article, $cgi, 'stepparent',
2917 "Stepparent $step_parent_id not found");
2919 $req->user_can(edit_stepkid_delete => $step_parent)
2920 or die "You don't have access to remove the stepkid from that article\n";
2923 BSE::Admin::StepParents->del($step_parent, $article);
2925 $@ and return $self->refresh($article, $cgi, 'stepparents', $@);
2927 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
2929 return $self->refresh($article, $cgi, 'stepparents', 'Stepparent deleted');
2932 sub save_stepparents {
2933 my ($self, $req, $article, $articles) = @_;
2935 $req->check_csrf("admin_save_stepparents")
2936 or return $self->csrf_error($req, $article, "admin_save_stepparents", "Save Stepparents");
2937 $req->user_can(edit_stepparent_save => $article)
2938 or return $self->edit_form($req, $article, $articles,
2939 "No access to save stepparent data for this artice");
2941 my $cgi = $req->cgi;
2943 require 'BSE/Admin/StepParents.pm';
2944 my @stepparents = BSE::TB::OtherParents->getBy(childId=>$article->{id});
2945 my %stepparents = map { $_->{parentId}, $_ } @stepparents;
2946 my %datedefs = ( release => '2000-01-01', expire=>'2999-12-31' );
2947 for my $stepparent (@stepparents) {
2948 $req->user_can(edit_stepkid_save => $stepparent->{parentId})
2950 for my $name (qw/release expire/) {
2951 my $date = $cgi->param($name.'_'.$stepparent->{parentId});
2952 if (defined $date) {
2954 $date = $datedefs{$name};
2956 elsif (dh_parse_date($date)) {
2957 use BSE::Util::SQL qw/date_to_sql/;
2958 $date = date_to_sql($date);
2961 return $self->refresh($article, $cgi, "Invalid date '$date'");
2963 $stepparent->{$name} = $date;
2967 $stepparent->save();
2969 $@ and return $self->refresh($article, $cgi, '', $@);
2972 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
2974 return $self->refresh($article, $cgi, 'stepparents',
2975 'Stepparent information saved');
2979 my ($self, $article, $cgi, $name, $message, $extras) = @_;
2981 my $url = $cgi->param('r');
2983 if ($url !~ /[?&](m|message)=/ && $message) {
2984 # add in messages if none in the provided refresh
2985 my @msgs = ref $message ? @$message : $message;
2986 my $sep = $url =~ /\?/ ? "&" : "?";
2987 for my $msg (@msgs) {
2988 $url .= $sep . "m=" . CGI::escape($msg);
2993 my $urlbase = admin_base_url($self->{cfg});
2994 $url = "$urlbase$ENV{SCRIPT_NAME}?id=$article->{id}";
2996 my @msgs = ref $message ? @$message : $message;
2997 for my $msg (@msgs) {
2998 $url .= "&m=" . CGI::escape($msg);
3001 if ($cgi->param('_t')) {
3002 $url .= "&_t=".CGI::escape($cgi->param('_t'));
3004 $url .= $extras if defined $extras;
3005 my $cgiextras = $cgi->param('e');
3006 $url .= "#$name" if $name;
3013 my ($self, $article, $cgi, $name, $message, $extras) = @_;
3015 my $url = $self->refresh_url($article, $cgi, $name, $message, $extras);
3017 return BSE::Template->get_refresh($url, $self->{cfg});
3021 my ($self, $req, $article, $articles, $msg, $errors) = @_;
3024 %acts = $self->low_edit_tags(\%acts, $req, $article, $articles, $msg, $errors);
3025 my $template = 'admin/article_img';
3027 return $req->dyn_response($template, \%acts);
3030 sub save_image_changes {
3031 my ($self, $req, $article, $articles) = @_;
3033 $req->check_csrf("admin_save_images")
3034 or return $self->csrf_error($req, $article, "admin_save_images", "Save Images");
3036 $req->user_can(edit_images_save => $article)
3037 or return $self->edit_form($req, $article, $articles,
3038 "You don't have access to save image information for this article");
3040 my $image_dir = cfg_image_dir($req->cfg);
3042 my $cgi = $req->cgi;
3043 my $image_pos = $cgi->param('imagePos');
3045 && $image_pos =~ /^(?:tl|tr|bl|br|xx)$/
3046 && $image_pos ne $article->{imagePos}) {
3047 $article->{imagePos} = $image_pos;
3050 my @images = $self->get_images($article);
3053 return $self->refresh($article, $cgi, undef, 'No images to save information for');
3060 for my $image (@images) {
3061 my $id = $image->{id};
3063 my $alt = $cgi->param("alt$id");
3064 if ($alt ne $image->{alt}) {
3065 $changes{$id}{alt} = $alt;
3068 my $url = $cgi->param("url$id");
3069 if (defined $url && $url ne $image->{url}) {
3070 $changes{$id}{url} = $url;
3073 my $name = $cgi->param("name$id");
3074 if (defined $name && $name ne $image->{name}) {
3076 $changes{$id}{name} = '';
3078 elsif ($name =~ /^[a-z_]\w*$/i) {
3080 if ($self->validate_image_name($name, \$msg)) {
3081 # check for duplicates after the loop
3082 push @{$names{lc $name}}, $image->{id}
3084 $changes{$id}{name} = $name;
3087 $errors{"name$id"} = $msg;
3091 $errors{"name$id"} = 'Image name must be empty or alphanumeric and unique to the article';
3095 push @{$names{lc $image->{name}}}, $image->{id}
3096 if length $image->{name};
3099 my $filename = $cgi->param("image$id");
3100 if (defined $filename && length $filename) {
3101 my $in_fh = $cgi->upload("image$id");
3105 my ($width, $height, $type) = $self->_validate_image
3106 ($filename, $in_fh, \$basename, \$image_error);
3109 $errors{"image$id"} = $image_error;
3112 unless ($errors{"image$id"}) {
3113 # work out where to put it
3114 require DevHelp::FileUpload;
3116 my ($image_name, $out_fh) = DevHelp::FileUpload->make_img_filename
3117 ($image_dir, $basename, \$msg);
3121 while ($data = <$in_fh>) {
3122 print $out_fh $data;
3126 my $full_filename = "$image_dir/$image_name";
3130 image => $image->{image},
3131 storage => $image->{storage}
3133 push @new_images, $image_name;
3135 $changes{$id}{image} = $image_name;
3136 $changes{$id}{storage} = 'local';
3137 $changes{$id}{src} = cfg_image_uri() . "/" . $image_name;
3138 $changes{$id}{width} = $width;
3139 $changes{$id}{height} = $height;
3140 $changes{$id}{ftype} = $self->_image_ftype($type);
3144 $errors{"image$id"} = $msg;
3150 $errors{"image$id"} = "No image file received";
3154 # look for duplicate names
3155 for my $name (keys %names) {
3156 if (@{$names{$name}} > 1) {
3157 for my $id (@{$names{$name}}) {
3158 $errors{"name$id"} = 'Image name must be unique to the article';
3163 # remove files that won't be stored because validation failed
3164 unlink map "$image_dir/$_", @new_images;
3166 return $self->edit_form($req, $article, $articles, undef,
3170 my $mgr = $self->_image_manager($req->cfg);
3171 $req->flash('Image information saved');
3172 my $changes_found = 0;
3173 my $auto_store = $cgi->param('auto_storage');
3174 for my $image (@images) {
3175 my $id = $image->{id};
3177 if ($changes{$id}) {
3178 my $changes = $changes{$id};
3181 for my $field (keys %$changes) {
3182 $image->{$field} = $changes->{$field};
3187 my $old_storage = $image->{storage};
3188 my $new_storage = $auto_store ? '' : $cgi->param("storage$id");
3189 defined $new_storage or $new_storage = $image->{storage};
3190 $new_storage = $mgr->select_store($image->{image}, $new_storage, $image);
3191 if ($new_storage ne $old_storage) {
3193 $image->{src} = $mgr->store($image->{image}, $new_storage, $image);
3194 $image->{storage} = $new_storage;
3198 if ($old_storage ne 'local') {
3199 $mgr->unstore($image->{image}, $old_storage);
3204 # delete any image files that were replaced
3205 for my $old_image (values %old_images) {
3206 my ($image, $storage) = @$old_image{qw/image storage/};
3207 if ($storage ne 'local') {
3208 $mgr->unstore($image->{image}, $storage);
3210 unlink "$image_dir/$image";
3213 if ($changes_found) {
3214 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
3217 return $self->refresh($article, $cgi);
3220 =item _service_error
3222 This function is called on various errors.
3224 If a _service parameter was supplied, returns text like:
3230 Field-Error: I<field-name1> - I<message1>
3232 Field-Error: I<field-name2> - I<message2>
3236 If the request is detected as an ajax request or a _ parameter is
3237 supplied, return JSON like:
3239 { error: I<message> }
3241 Otherwise display the normal edit page with the error.
3245 sub _service_error {
3246 my ($self, $req, $article, $articles, $msg, $error, $code, $method) = @_;
3250 $article = $self->_dummy_article($req, $articles, \$mymsg);
3253 map $_ => '', BSE::TB::Article->columns
3257 if ($req->cgi->param('_service')) {
3259 $body .= "Result: failure\n";
3261 for my $field (keys %$error) {
3262 my $text = $error->{$field};
3264 $body .= "Field-Error: $field - $text\n";
3266 my $text = join ('/', values %$error);
3268 $body .= "Error: $text\n";
3271 $body .= "Error: $msg\n";
3274 $body .= "Error: $error\n";
3278 type => 'text/plain',
3282 elsif ((() = $req->cgi->param('_')) ||
3283 (exists $ENV{HTTP_X_REQUESTED_WITH}
3284 && $ENV{HTTP_X_REQUESTED_WITH} =~ /XMLHttpRequest/)) {
3291 $msg and $result->{message} = $msg;
3292 $code and $result->{error_code} = $code;
3293 my $json_result = $req->json_content($result);
3295 if (!exists $ENV{HTTP_X_REQUESTED_WITH}
3296 || $ENV{HTTP_X_REQUESTED_WITH} !~ /XMLHttpRequest/) {
3297 $json_result->{type} = "text/plain";
3300 return $json_result;
3303 $method ||= "edit_form";
3304 return $self->$method($req, $article, $articles, $msg, $error);
3308 sub _service_success {
3309 my ($self, $results) = @_;
3311 my $body = "Result: success\n";
3312 for my $field (keys %$results) {
3313 $body .= "$field: $results->{$field}\n";
3317 type => 'text/plain',
3322 # FIXME: eliminate this method and call get_ftype directly
3324 my ($self, $type) = @_;
3326 require BSE::TB::Images;
3327 return BSE::TB::Images->get_ftype($type);
3334 pnm => "pbm,pgm,ppm",
3337 sub _validate_image {
3338 my ($self, $filename, $fh, $rbasename, $error) = @_;
3342 $$error = 'Image file is empty';
3347 $$error = 'Please enter an image filename';
3350 my $imagename = $filename;
3351 $imagename .= ''; # force it into a string
3353 $imagename =~ tr/ //d;
3354 $imagename =~ /([\w.-]+)$/ and $basename = $1;
3356 # for OSs with special text line endings
3357 require BSE::ImageSize;
3359 my ($width,$height, $type) = BSE::ImageSize::imgsize($fh);
3361 unless (defined $width) {
3362 $$error = "Unknown image file type";
3366 my $lctype = lc $type;
3367 my @valid_exts = split /,/,
3368 BSE::Cfg->single->entry("valid image extensions", $lctype,
3369 $valid_exts{$lctype} || $lctype);
3371 my ($ext) = $basename =~ /\.(\w+)\z/;
3372 if (!$ext || !grep $_ eq lc $ext, @valid_exts) {
3373 $basename .= ".$valid_exts[0]";
3375 $$rbasename = $basename;
3377 return ($width, $height, $type);
3380 my $last_display_order = 0;
3383 my ($self, $cfg, $article, $image, %opts) = @_;
3385 my $errors = $opts{errors}
3386 or die "No errors parameter";
3388 my $imageref = $opts{name};
3389 if (defined $imageref && $imageref ne '') {
3390 if ($imageref =~ /^[a-z_]\w+$/i) {
3391 # make sure it's unique
3392 my @images = $self->get_images($article);
3393 for my $img (@images) {
3394 if (defined $img->{name} && lc $img->{name} eq lc $imageref) {
3395 $errors->{name} = 'Image name must be unique to the article';
3401 $errors->{name} = 'Image name must be empty or alphanumeric beginning with an alpha character';
3407 unless ($errors->{name}) {
3409 $self->validate_image_name($imageref, \$workmsg)
3410 or $errors->{name} = $workmsg;
3415 my ($width, $height, $type) =
3416 $self->_validate_image($opts{filename} || $image, $image, \$basename,
3419 $errors->{image} = $image_error;
3425 # for the sysopen() constants
3428 my $imagedir = cfg_image_dir($cfg);
3430 require DevHelp::FileUpload;
3432 my ($filename, $fh) =
3433 DevHelp::FileUpload->make_img_filename($imagedir, $basename, \$msg);
3434 unless ($filename) {
3435 $errors->{image} = $msg;
3445 # read the image in from the browser and output it to our output filehandle
3446 print $fh $buffer while read $image, $buffer, 1024;
3450 or die "Could not close image file $filename: $!";
3452 my $display_order = time;
3453 if ($display_order <= $last_display_order) {
3454 $display_order = $last_display_order + 1;
3456 $last_display_order = $display_order;
3458 my $alt = $opts{alt};
3459 defined $alt or $alt = '';
3460 my $url = $opts{url};
3461 defined $url or $url = '';
3464 articleId => $article->{id},
3470 displayOrder => $display_order,
3473 src => cfg_image_uri() . '/' . $filename,
3474 ftype => $self->_image_ftype($type),
3476 require BSE::TB::Images;
3477 my @cols = BSE::TB::Image->columns;
3479 my $imageobj = BSE::TB::Images->add(@image{@cols});
3481 my $storage = $opts{storage};
3482 defined $storage or $storage = 'local';
3483 my $image_manager = $self->_image_manager($cfg);
3484 local $SIG{__DIE__};
3487 $storage = $image_manager->select_store($filename, $storage, $imageobj);
3488 $src = $image_manager->store($filename, $storage, $imageobj);
3491 $imageobj->{src} = $src;
3492 $imageobj->{storage} = $storage;
3497 $errors->{flash} = $@;
3504 my ($self, $cfg, $image) = @_;
3506 my $data = $image->data_only;
3507 $data->{src} = $image->image_url($cfg);
3513 my ($self, $req, $article, $articles) = @_;
3515 $req->check_csrf("admin_add_image")
3516 or return $self->csrf_error($req, $article, "admin_add_image", "Add Image");
3517 $req->user_can(edit_images_add => $article)
3518 or return $self->_service_error($req, $article, $articles,
3519 "You don't have access to add new images to this article");
3521 my $cgi = $req->cgi;
3525 my $save_tags = $cgi->param("_save_tags");
3528 @tags = $cgi->param("tags");
3529 $self->_validate_tags(\@tags, \%errors);
3537 scalar($cgi->upload('image')),
3538 name => scalar($cgi->param('name')),
3539 alt => scalar($cgi->param('altIn')),
3540 url => scalar($cgi->param('url')),
3541 storage => scalar($cgi->param('storage')),
3543 filename => scalar($cgi->param("image")),
3547 or return $self->_service_error($req, $article, $articles, undef, \%errors);
3551 $imageobj->set_tags([ grep /\S/, @tags ], \$error);
3554 # typically a soft failure from the storage
3556 and $req->flash($errors{flash});
3558 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
3560 if ($cgi->param('_service')) {
3561 return $self->_service_success
3564 image => $imageobj->{id},
3568 elsif ($cgi->param("_") || $req->is_ajax) {
3569 my $resp = $req->json_content
3572 image => $self->_image_data($req->cfg, $imageobj),
3575 # the browser handles this directly, tell it that it's text
3576 $resp->{type} = "text/plain";
3581 return $self->refresh($article, $cgi, undef, 'New image added');
3585 sub _image_manager {
3588 require BSE::TB::Images;
3589 return BSE::TB::Images->storage_manager;
3594 my ($self, $req, $article, $articles, $imageid) = @_;
3596 $req->check_csrf("admin_remove_image")
3597 or return $self->csrf_error($req, $article, "admin_remove_image", "Remove Image");
3599 $req->user_can(edit_images_delete => $article)
3600 or return $self->_service_error($req, $article, $articles,
3601 "You don't have access to delete images from this article", {}, "ACCESS");
3605 my @images = $self->get_images($article);
3606 my ($image) = grep $_->{id} == $imageid, @images;
3608 if ($req->want_json_response) {
3609 return $self->_service_error($req, $article, $articles, "No such image", {}, "NOTFOUND");
3612 return $self->show_images($req, $article, $articles, "No such image");
3616 if ($image->{storage} ne 'local') {
3617 my $mgr = $self->_image_manager($req->cfg);
3618 $mgr->unstore($image->{image}, $image->{storage});
3621 my $imagedir = cfg_image_dir($req->cfg);
3624 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
3626 if ($req->want_json_response) {
3627 return $req->json_content
3633 return $self->refresh($article, $req->cgi, undef, 'Image removed');
3637 my ($self, $req, $article, $articles) = @_;
3639 $req->check_csrf("admin_move_image")
3640 or return $self->csrf_error($req, $article, "admin_move_image", "Move Image");
3641 $req->user_can(edit_images_reorder => $article)
3642 or return $self->edit_form($req, $article, $articles,
3643 "You don't have access to reorder images in this article");
3645 my $imageid = $req->cgi->param('imageid');
3646 my @images = $self->get_images($article);
3647 my ($imgindex) = grep $images[$_]{id} == $imageid, 0..$#images
3648 or return $self->edit_form($req, $article, $articles, "No such image");
3650 or return $self->edit_form($req, $article, $articles, "Image is already at the top");
3651 my ($to, $from) = @images[$imgindex-1, $imgindex];
3652 ($to->{displayOrder}, $from->{displayOrder}) =
3653 ($from->{displayOrder}, $to->{displayOrder});
3657 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
3659 return $self->refresh($article, $req->cgi, undef, 'Image moved');
3663 my ($self, $req, $article, $articles) = @_;
3665 $req->check_csrf("admin_move_image")
3666 or return $self->csrf_error($req, $article, "admin_move_image", "Move Image");
3667 $req->user_can(edit_images_reorder => $article)
3668 or return $self->edit_form($req, $article, $articles,
3669 "You don't have access to reorder images in this article");
3671 my $imageid = $req->cgi->param('imageid');
3672 my @images = $self->get_images($article);
3673 my ($imgindex) = grep $images[$_]{id} == $imageid, 0..$#images
3674 or return $self->edit_form($req, $article, $articles, "No such image");
3675 $imgindex < $#images
3676 or return $self->edit_form($req, $article, $articles, "Image is already at the end");
3677 my ($to, $from) = @images[$imgindex+1, $imgindex];
3678 ($to->{displayOrder}, $from->{displayOrder}) =
3679 ($from->{displayOrder}, $to->{displayOrder});
3683 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
3685 return $self->refresh($article, $req->cgi, undef, 'Image moved');
3689 my ($self, $req, $article) = @_;
3691 my $cgi = $req->cgi;
3692 my $cfg = $req->cfg;
3693 my $im_id = $cgi->param('im');
3695 if (defined $im_id && $im_id =~ /^\d+$/) {
3696 ($image) = grep $_->{id} == $im_id, $self->get_images($article);
3698 my $thumb_obj = $self->_get_thumbs_class();
3700 if ($image && $thumb_obj) {
3701 my $geometry_id = $cgi->param('g');
3702 defined $geometry_id or $geometry_id = 'editor';
3703 my $geometry = $cfg->entry('thumb geometries', $geometry_id, 'scale(200x200)');
3704 my $imagedir = cfg_image_dir();
3707 ($data, $type) = $thumb_obj->thumb_data
3709 filename => "$imagedir/$image->{image}",
3710 geometry => $geometry,
3715 type => 'text/plain',
3716 content => 'Error: '.$error
3720 if ($type && $data) {
3727 "Content-Length: ".length($data),
3728 "Cache-Control: max-age=3600",
3733 # grab the nothumb image
3734 my $uri = $cfg->entry('editor', 'default_thumbnail', cfg_dist_image_uri() . '/admin/nothumb.png');
3735 my $filebase = $cfg->content_base_path;
3736 if (open IMG, "<$filebase/$uri") {
3738 my $data = do { local $/; <IMG> };
3740 my $type = $uri =~ /\.(\w+)$/ ? $1 : 'png';
3743 type => "image/$type",
3745 headers => [ "Content-Length: ".length($data) ],
3752 content => "<html><body>Cannot make thumb or default image</body></html>",
3760 Display a form to allow editing an image.
3768 eimage - the image being edited
3772 normal article edit tags.
3778 eimage - the image being edited.
3782 sub req_edit_image {
3783 my ($self, $req, $article, $articles, $errors) = @_;
3785 my $cgi = $req->cgi;
3787 my $id = $cgi->param('image_id');
3789 my ($image) = grep $_->{id} == $id, $self->get_images($article)
3790 or return $self->edit_form($req, $article, $articles,
3792 $req->user_can(edit_images_save => $article)
3793 or return $self->edit_form($req, $article, $articles,
3794 "You don't have access to save image information for this article");
3796 $req->set_variable(eimage => $image);
3801 $self->low_edit_tags(\%acts, $req, $article, $articles, undef,
3803 eimage => [ \&tag_hash, $image ],
3804 error_img => [ \&tag_error_img, $req->cfg, $errors ],
3807 return $req->response('admin/image_edit', \%acts);
3812 Save changes to an image.
3828 alt, url, name - text fields to update
3832 image - replacement image data (if any)
3838 sub req_save_image {
3839 my ($self, $req, $article, $articles) = @_;
3841 $req->check_csrf("admin_save_image")
3842 or return $self->csrf_error($req, $article, "admin_save_image", "Save Image");
3843 my $cgi = $req->cgi;
3845 my $id = $cgi->param('image_id');
3847 my @images = $self->get_images($article);
3848 my ($image) = grep $_->{id} == $id, @images
3849 or return $self->_service_error($req, $article, $articles, "No such image",
3851 $req->user_can(edit_images_save => $article)
3852 or return $self->_service_error($req, $article, $articles,
3853 "You don't have access to save image information for this article", {}, "ACCESS");
3855 my $image_dir = cfg_image_dir($req->cfg);
3857 my $old_storage = $image->{storage};
3861 my $alt = $cgi->param('alt');
3862 defined $alt and $image->{alt} = $alt;
3863 my $url = $cgi->param('url');
3864 defined $url and $image->{url} = $url;
3865 my @other_images = grep $_->{id} != $id, @images;
3866 my $name = $cgi->param('name');
3867 if (defined $name) {
3869 if ($name !~ /^[a-z_]\w*$/i) {
3870 $errors{name} = 'Image name must be empty or alphanumeric and unique to the article';
3872 elsif (grep $name eq $_->{name}, @other_images) {
3873 $errors{name} = 'Image name must be unique to the article';
3876 $image->{name} = $name;
3880 $image->{name} = '';
3883 my $filename = $cgi->param('image');
3884 if (defined $filename && length $filename) {
3885 my $in_fh = $cgi->upload('image');
3889 my ($width, $height, $type) = $self->_validate_image
3890 ($filename, $in_fh, \$basename, \$image_error);
3892 require DevHelp::FileUpload;
3894 my ($image_name, $out_fh) = DevHelp::FileUpload->make_img_filename
3895 ($image_dir, $basename, \$msg);
3900 while ($data = <$in_fh>) {
3901 print $out_fh $data;
3906 my $full_filename = "$image_dir/$image_name";
3907 $delete_file = $image->{image};
3908 $image->{image} = $image_name;
3909 $image->{width} = $width;
3910 $image->{height} = $height;
3911 $image->{storage} = 'local'; # not on the remote store yet
3912 $image->{src} = cfg_image_uri() . '/' . $image_name;
3913 $image->{ftype} = $self->_image_ftype($type);
3916 $errors{image} = $msg;
3920 $errors{image} = $image_error;
3924 $errors{image} = "No image file received";
3927 my $save_tags = $cgi->param("_save_tags");
3930 @tags = $cgi->param("tags");
3931 $self->_validate_tags(\@tags, \%errors);
3934 if ($req->want_json_response) {
3935 return $self->_service_error($req, $article, $articles, undef,
3939 return $self->req_edit_image($req, $article, $articles, \%errors);
3943 my $new_storage = $cgi->param('storage');
3944 defined $new_storage or $new_storage = $image->{storage};
3948 $image->set_tags([ grep /\S/, @tags ], \$error);
3950 my $mgr = $self->_image_manager($req->cfg);
3952 if ($old_storage ne 'local') {
3953 $mgr->unstore($delete_file, $old_storage);
3955 unlink "$image_dir/$delete_file";
3957 $req->flash("Image saved");
3960 $mgr->select_store($image->{image}, $new_storage);
3961 if ($image->{storage} ne $new_storage) {
3962 # handles both new images (which sets storage to local) and changing
3963 # the storage for old images
3964 my $old_storage = $image->{storage};
3965 my $src = $mgr->store($image->{image}, $new_storage, $image);
3966 $image->{src} = $src;
3967 $image->{storage} = $new_storage;
3971 $@ and $req->flash("There was a problem adding it to the new storage: $@");
3972 if ($image->{storage} ne $old_storage && $old_storage ne 'local') {
3974 $mgr->unstore($image->{image}, $old_storage);
3976 $@ and $req->flash("There was a problem removing if from the old storage: $@");
3979 if ($req->want_json_response) {
3980 return $req->json_content
3983 image => $self->_image_data($req->cfg, $image),
3987 return $self->refresh($article, $cgi);
3990 =item a_order_images
3992 Change the order of images for an article (or global images).
4000 id - id of the article to change the image order for (-1 for global
4005 order - comma-separated list of image ids in the new order.
4011 sub req_order_images {
4012 my ($self, $req, $article, $articles) = @_;
4015 or return $self->_service_error($req, $article, $articles, "The function only permitted from Ajax", {}, "AJAXONLY");
4017 my $order = $req->cgi->param("order");
4019 or return $self->_service_error($req, $article, $articles, "order not supplied", {}, "NOORDER");
4020 $order =~ /^\d+(,\d+)*$/
4021 or return $self->_service_error($req, $article, $articles, "order not supplied", {}, "BADORDER");
4023 my @order = split /,/, $order;
4025 my @images = $article->set_image_order(\@order);
4027 return $req->json_content
4032 map $self->_image_data($req->cfg, $_), @images
4038 my ($self, $articles, $article) = @_;
4044 my ($self, $articles) = @_;
4049 sub _refresh_filelist {
4050 my ($self, $req, $article, $msg) = @_;
4052 return $self->refresh($article, $req->cgi, undef, $msg);
4056 my ($self, $req, $article, $articles, $msg, $errors) = @_;
4059 %acts = $self->low_edit_tags(\%acts, $req, $article, $articles, $msg, $errors);
4060 my $template = 'admin/filelist';
4062 return BSE::Template->get_response($template, $req->cfg, \%acts);
4069 maxlength => MAX_FILE_DISPLAYNAME_LENGTH,
4070 description => 'Filename'
4074 rules => 'dh_one_line',
4076 description => 'Description',
4080 description => 'Identifier',
4085 description => "Category",
4091 my ($self, $req, $article, $articles) = @_;
4093 $req->check_csrf("admin_add_file")
4094 or return $self->csrf_error($req, $article, "admin_add_file", "Add File");
4095 $req->user_can(edit_files_add => $article)
4096 or return $self->_service_error($req, $article, $articles,
4097 "You don't have access to add files to this article");
4100 my $cgi = $req->cgi;
4101 require BSE::TB::ArticleFiles;
4102 my @cols = BSE::TB::ArticleFile->columns;
4104 for my $col (@cols) {
4105 if (defined $cgi->param($col)) {
4106 $file{$col} = $cgi->param($col);
4112 $req->validate(errors => \%errors,
4113 fields => \%file_fields,
4114 section => $article->{id} == -1 ? 'Global File Validation' : 'Article File Validation');
4117 my $file = $cgi->upload('file');
4118 my $filename = $cgi->param("file");
4120 $errors{file} = 'Please enter a filename';
4122 if ($file && -z $file) {
4123 $errors{file} = 'File is empty';
4126 $file{forSale} = 0 + exists $file{forSale};
4127 $file{articleId} = $article->{id};
4128 $file{download} = 0 + exists $file{download};
4129 $file{requireUser} = 0 + exists $file{requireUser};
4130 $file{hide_from_list} = 0 + exists $file{hide_from_list};
4131 $file{category} ||= '';
4133 defined $file{name} or $file{name} = '';
4134 if (!$errors{name} && length $file{name} && $file{name} !~/^\w+$/) {
4135 $errors{name} = "Identifier must be a single word";
4137 if (!$errors{name} && length $file{name}) {
4138 my @files = $self->get_files($article);
4139 if (grep lc $_->{name} eq lc $file{name}, @files) {
4140 $errors{name} = "Duplicate file identifier $file{name}";
4145 and return $self->_service_error($req, $article, $articles, undef, \%errors);
4148 my $workfile = $filename;
4149 $workfile =~ s![^\w.:/\\-]+!_!g;
4150 $workfile =~ tr/_/_/s;
4151 $workfile =~ /([ \w.-]+)$/ and $basename = $1;
4152 $basename =~ tr/ /_/;
4153 $file{displayName} = $basename;
4154 $file{file} = $file;
4156 local $SIG{__DIE__};
4159 $article->add_file($self->cfg, %file);
4163 or return $self->_service_error($req, $article, $articles, $@);
4165 unless ($req->is_ajax) {
4166 $req->flash("New file added");
4172 file => $fileobj->data_only,
4175 my $storage = $cgi->param("storage") || "";
4179 $article->apply_storage($self->cfg, $fileobj, $storage, \$msg);
4182 if ($req->is_ajax) {
4183 push @{$json->{warnings}}, $msg;
4186 $req->flash_error($msg);
4191 if ($req->is_ajax) {
4192 push @{$json->{warnings}}, $@;
4195 $req->flash_error($@);
4199 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
4201 if ($req->is_ajax) {
4202 return $req->json_content($json);
4205 $self->_refresh_filelist($req, $article);
4210 my ($self, $req, $article, $articles) = @_;
4212 $req->check_csrf("admin_move_file")
4213 or return $self->csrf_error($req, $article, "admin_move_file", "Move File");
4215 $req->user_can('edit_files_reorder', $article)
4216 or return $self->edit_form($req, $article, $articles,
4217 "You don't have access to reorder files in this article");
4219 my $cgi = $req->cgi;
4220 my $id1 = $cgi->param('file1');
4221 my $id2 = $cgi->param('file2');
4224 my @files = $self->get_files($article);
4226 my ($file1) = grep $_->{id} == $id1, @files;
4227 my ($file2) = grep $_->{id} == $id2, @files;
4229 if ($file1 && $file2) {
4230 ($file1->{displayOrder}, $file2->{displayOrder})
4231 = ($file2->{displayOrder}, $file1->{displayOrder});
4237 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
4239 $self->refresh($article, $req->cgi, undef, 'File moved');
4243 my ($self, $req, $article, $articles) = @_;
4245 $req->check_csrf("admin_remove_file")
4246 or return $self->csrf_error($req, $article, "admin_remove_file", "Delete File");
4247 $req->user_can('edit_files_delete', $article)
4248 or return $self->edit_form($req, $article, $articles,
4249 "You don't have access to delete files from this article");
4251 my $cgi = $req->cgi;
4252 my $fileid = $cgi->param('file');
4254 my @files = $self->get_files($article);
4256 my ($file) = grep $_->{id} == $fileid, @files;
4259 if ($file->{storage} ne 'local') {
4260 my $mgr = $self->_file_manager($self->cfg);
4261 $mgr->unstore($file->{filename}, $file->{storage});
4264 $file->remove($req->cfg);
4268 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
4270 $self->_refresh_filelist($req, $article, 'File deleted');
4274 my ($self, $req, $article, $articles) = @_;
4276 $req->check_csrf("admin_save_files")
4277 or return $self->csrf_error($req, $article, "admin_save_files", "Save Files");
4279 $req->user_can('edit_files_save', $article)
4280 or return $self->edit_form($req, $article, $articles,
4281 "You don't have access to save file information for this article");
4282 my @files = $self->get_files($article);
4284 my $download_path = BSE::TB::ArticleFiles->download_path($self->{cfg});
4286 my $cgi = $req->cgi;
4292 my $change_count = 0;
4293 my @content_changed;
4294 for my $file (@files) {
4295 my $id = $file->{id};
4296 my $orig = $file->data_only;
4297 my $desc = $cgi->param("description_$id");
4298 defined $desc and $file->{description} = $desc;
4299 my $type = $cgi->param("contentType_$id");
4300 if (defined $type and $type ne $file->{contentType}) {
4301 ++$store_anyway{$id};
4302 $file->{contentType} = $type;
4304 my $notes = $cgi->param("notes_$id");
4305 defined $notes and $file->{notes} = $notes;
4306 my $category = $cgi->param("category_$id");
4307 defined $category and $file->{category} = $category;
4308 my $name = $cgi->param("name_$id");
4309 if (defined $name) {
4310 $file->{name} = $name;
4312 if ($name =~ /^\w+$/) {
4313 push @{$names{$name}}, $id;
4316 $errors{"name_$id"} = "Invalid file identifier $name";
4321 push @{$names{$file->{name}}}, $id
4322 if length $file->{name};
4324 if ($cgi->param('save_file_flags')) {
4325 my $download = 0 + defined $cgi->param("download_$id");
4326 if ($download != $file->{download}) {
4327 ++$store_anyway{$file->{id}};
4328 $file->{download} = $download;
4330 $file->{forSale} = 0 + defined $cgi->param("forSale_$id");
4331 $file->{requireUser} = 0 + defined $cgi->param("requireUser_$id");
4332 $file->{hide_from_list} = 0 + defined $cgi->param("hide_from_list_$id");
4335 my $filex = $cgi->param("file_$id");
4336 my $in_fh = $cgi->upload("file_$id");
4337 if (defined $filex && length $filex) {
4338 if (length $filex <= MAX_FILE_DISPLAYNAME_LENGTH) {
4341 require DevHelp::FileUpload;
4343 my ($file_name, $out_fh) = DevHelp::FileUpload->make_img_filename
4344 ($download_path, $filex . '', \$msg);
4349 while ($data = <$in_fh>) {
4350 print $out_fh $data;
4354 my $display_name = $filex;
4355 $display_name =~ s!.*[\\:/]!!;
4356 $display_name =~ s/[^\w._-]+/_/g;
4357 my $full_name = "$download_path/$file_name";
4358 push @old_files, [ $file->{filename}, $file->{storage} ];
4359 push @new_files, $file_name;
4361 $file->{filename} = $file_name;
4362 $file->{storage} = 'local';
4363 $file->{sizeInBytes} = -s $full_name;
4364 $file->{whenUploaded} = now_sqldatetime();
4365 $file->{displayName} = $display_name;
4366 push @content_changed, $file;
4369 $errors{"file_$id"} = $msg;
4373 $errors{"file_$id"} = "File is empty";
4377 $errors{"file_$id"} = "No file data received";
4381 $errors{"file_$id"} = "Filename too long";
4385 my $new = $file->data_only;
4387 for my $col ($file->columns) {
4388 if ($new->{$col} ne $orig->{$col}) {
4394 for my $name (keys %names) {
4395 if (@{$names{$name}} > 1) {
4396 for my $id (@{$names{$name}}) {
4397 $errors{"name_$id"} = 'File identifier must be unique to the article';
4402 # remove the uploaded replacements
4403 unlink map "$download_path/$_", @new_files;
4405 return $self->edit_form($req, $article, $articles, undef, \%errors);
4407 if ($change_count) {
4408 $req->flash("msg:bse/admin/edit/file/save/success_count", [ $change_count ]);
4411 $req->flash("msg:bse/admin/edit/file/save/success_none");
4413 my $mgr = $self->_file_manager($self->cfg);
4414 for my $file (@files) {
4417 my $storage = $cgi->param("storage_$file->{id}");
4418 defined $storage or $storage = 'local';
4420 $storage = $article->select_filestore($mgr, $file, $storage, \$msg);
4421 $msg and $req->flash($msg);
4422 if ($storage ne $file->{storage} || $store_anyway{$file->{id}}) {
4423 my $old_storage = $file->{storage};
4425 $file->{src} = $mgr->store($file->{filename}, $storage, $file);
4426 $file->{storage} = $storage;
4429 if ($old_storage ne $storage) {
4430 $mgr->unstore($file->{filename}, $old_storage);
4434 and $req->flash("Could not move $file->{displayName} to $storage: $@");
4438 # remove the replaced files
4439 for my $file (@old_files) {
4440 my ($filename, $storage) = @$file;
4443 $mgr->unstore($filename, $storage);
4446 and $req->flash("Error removing $filename from $storage: $@");
4448 unlink "$download_path/$filename";
4451 # update file type metadatas
4452 for my $file (@content_changed) {
4453 $file->set_handler($self->{cfg});
4457 generate_article($articles, $article) if $Constants::AUTO_GENERATE;
4459 $self->_refresh_filelist($req, $article);
4463 my ($self, $req, $article, $articles, $errors) = @_;
4465 my $cgi = $req->cgi;
4467 my $id = $cgi->param('file_id');
4469 my ($file) = grep $_->{id} == $id, $self->get_files($article)
4470 or return $self->edit_form($req, $article, $articles,
4472 $req->user_can(edit_files_save => $article)
4473 or return $self->edit_form($req, $article, $articles,
4474 "You don't have access to save file information for this article");
4476 my $name = $cgi->param('name');
4477 $name && $name =~ /^\w+$/
4478 or return $self->edit_form($req, $article, $articles,
4479 "Missing or invalid metadata name");
4481 my $meta = $file->meta_by_name($name)
4482 or return $self->edit_form($req, $article, $articles,
4483 "Metadata $name not defined for this file");
4487 type => $meta->content_type,
4488 content => $meta->value,
4492 sub tag_old_checked {
4493 my ($errors, $cgi, $file, $key) = @_;
4495 return $errors ? $cgi->param($key) : $file->{$key};
4498 sub tag_filemeta_value {
4499 my ($file, $args, $acts, $funcname, $templater) = @_;
4501 my ($name) = DevHelp::Tags->get_parms($args, $acts, $templater)
4502 or return "* no meta name supplied *";
4504 my $meta = $file->meta_by_name($name)
4507 $meta->content_type eq "text/plain"
4508 or return "* $name has type " . $meta->content_type . " and cannot be displayed inline *";
4510 return escape_html($meta->value);
4513 sub tag_ifFilemeta_set {
4514 my ($file, $args, $acts, $funcname, $templater) = @_;
4516 my ($name) = DevHelp::Tags->get_parms($args, $acts, $templater)
4517 or return "* no meta name supplied *";
4519 my $meta = $file->meta_by_name($name)
4525 sub tag_filemeta_source {
4526 my ($file, $args, $acts, $funcname, $templater) = @_;
4528 my ($name) = DevHelp::Tags->get_parms($args, $acts, $templater)
4529 or return "* no meta name supplied *";
4531 return "$ENV{SCRIPT_NAME}?a_filemeta=1&id=$file->{articleId}&file_id=$file->{id}&name=$name";
4534 sub tag_filemeta_select {
4535 my ($cgi, $allmeta, $rcurr_meta, $file, $args, $acts, $funcname, $templater) = @_;
4538 if ($args =~ /\S/) {
4539 my ($name) = DevHelp::Tags->get_parms($args, $acts, $templater)
4540 or return "* cannot parse *";
4541 ($meta) = grep $_->name eq $name, @$allmeta
4542 or return "* cannot find meta field *";
4544 elsif ($$rcurr_meta) {
4545 $meta = $$rcurr_meta;
4548 return "* use in filemeta iterator or supply a name *";
4551 $meta->type eq "enum"
4552 or return "* can only use filemeta_select on enum metafields *";
4555 my @values = $meta->values;
4556 @labels{@values} = $meta->labels;
4558 my $field_name = "meta_" . $meta->name;
4559 my ($def) = $cgi->param($field_name);
4560 unless (defined $def) {
4561 my $value = $file->meta_by_name($meta->name);
4562 if ($value && $value->is_text) {
4563 $def = $value->value;
4566 defined $def or $def = $values[0];
4570 -name => $field_name,
4571 -values => \@values,
4572 -labels => \%labels,
4577 sub tag_filemeta_select_label {
4578 my ($allmeta, $rcurr_meta, $file, $args, $acts, $funcname, $templater) = @_;