migrate to JsonTable to edit template attachments

This commit is contained in:
Doug Bell 2010-06-30 17:03:50 -05:00
parent 129016325d
commit 6cf68e59a2
4 changed files with 255 additions and 83 deletions

View file

@ -207,12 +207,18 @@ If defined, will limit the attachments to this type; e.g., passing
sub getAttachments {
my ( $self, $type ) = @_;
if ( !$self->{_attachments} ) {
$self->{_attachments} = JSON->new->decode( $self->get('attachmentsJson') );
return [] if !$self->get('attachmentsJson');
my $attachments = JSON->new->decode( $self->get('attachmentsJson') );
# We want it all and we want it now
if ( !$type ) {
return $attachments;
}
my $output = [];
for my $attach ( @{$self->{_attachments}} ) {
for my $attach ( @{$attachments} ) {
if ( $attach->{type} eq $type ) {
push @{$output}, $attach;
}
@ -293,7 +299,7 @@ sub getEditForm {
);
}
$properties->jsonTable(
$tabform->getTab('properties')->jsonTable(
name => 'attachmentsJson',
value => $self->get('attachmentsJson'),
label => $i18n->get("attachments display label"),
@ -317,7 +323,7 @@ sub getEditForm {
],
);
$properties->image(
$tabform->getTab('properties')->image(
name => 'storageIdExample',
value => $self->getValue('storageIdExample'),
label => $i18n->get('field storageIdExample'),
@ -588,6 +594,7 @@ Extends the master class to handle template parsers, namespaces and template att
sub processPropertiesFromFormPost {
my $self = shift;
my $session = $self->session;
$self->SUPER::processPropertiesFromFormPost;
# TODO: Perhaps add a way to check template syntax before it blows stuff up?
my %data;
@ -610,7 +617,7 @@ sub processPropertiesFromFormPost {
}
### Template attachments
$self->update({ attachmentsJson => $f->process( 'attachmentsJson', 'JsonTable' ), });
$self->update({ attachmentsJson => $session->form->process( 'attachmentsJson', 'JsonTable' ), });
return;
}
@ -650,70 +657,6 @@ sub processRaw {
#-------------------------------------------------------------------
=head2 purge ( )
Extend the master to purge attachments in all revisions.
=cut
sub purge {
my $self = shift;
$self->session->db->write('delete from template_attachments where templateId=?', [$self->getId]);
return $self->SUPER::purge(@_);
}
#-------------------------------------------------------------------
=head2 purgeRevision ( )
Extend the master purgeRevision to purge attachments
=cut
sub purgeRevision {
my $self = shift;
$self->removeAttachments;
return $self->SUPER::purgeRevision(@_);
}
#-------------------------------------------------------------------
=head2 removeAttachments ( urls )
Removes attachments. C<urls> is an arrayref of URLs to remove. If C<urls>
is not defined, will remove all attachments for this revision.
=cut
sub removeAttachments {
my ($self, $urls) = @_;
my $db = $self->session->db;
my $dbh = $db->dbh;
my $rmsql = qq{
DELETE FROM
template_attachments
WHERE
templateId = ?
AND revisionDate = ?
};
if ( $urls && @{$urls} ) {
my $in = join(',', map { $dbh->quote($_) } @{$urls});
$rmsql .= qq{
AND url IN ($in)
};
}
my @params = (
$self->getId,
$self->get('revisionDate'),
);
$db->write($rmsql, \@params);
}
#-------------------------------------------------------------------
=head2 update
Override update from Asset.pm to handle backwards compatibility with the old

View file

@ -0,0 +1,195 @@
package WebGUI::Form::JsonTable;
=head1 LEGAL
-------------------------------------------------------------------
WebGUI is Copyright 2001-2009 Plain Black Corporation.
-------------------------------------------------------------------
Please read the legal notices (docs/legal.txt) and the license
(docs/license.txt) that came with this distribution before using
this software.
-------------------------------------------------------------------
http://www.plainblack.com info@plainblack.com
-------------------------------------------------------------------
=cut
use strict;
use base 'WebGUI::Form::Control';
use WebGUI::International;
use JSON;
=head1 NAME
Package WebGUI::Form::JsonTable
=head1 DESCRIPTION
Creates a table to edit a JSON blob
=head1 SEE ALSO
This is a subclass of WebGUI::Form::Control.
=head1 METHODS
=cut
#-------------------------------------------------------------------
=head2 definition ( [ additionalTerms ] )
See the super class for additional details.
=head3 additionalTerms
The following additional parameters have been added via this sub class.
=head4 fields
An array of hashrefs defining the fields in this JsonTable.
{
type => "text", # One of "text", "select", or "readonly"
name => "name", # The name of the field
label => "Name", # an i18n label
options => [ option => "label", ... ] # Options for select fields
}
=cut
sub definition {
my $class = shift;
my $session = shift;
my $definition = shift || [];
push @{$definition}, {
fields => {
defaultValue => [],
},
};
return $class->SUPER::definition($session, $definition);
}
#-------------------------------------------------------------------
=head2 getName ( session )
Returns the name of the form control.
=cut
sub getName {
my ($class, $session) = @_;
return WebGUI::International->new($session, "Form_JsonTable")->get("topicName");
}
#-------------------------------------------------------------------
=head2 getValue ( value )
Get the value of the field. Substitute id fields with GUIDs.
=cut
sub getValue {
my ( $self, $value ) = @_;
$value ||= $self->SUPER::getValue;
$value = JSON->new->decode( $value );
for my $row ( @{$value} ) {
for my $field ( @{$self->get('fields')} ) {
if ( $field->{type} eq 'id' && $row->{ $field->{name} } eq "new" ) {
$row->{ $field->{name} } = $self->session->id->generate;
}
}
}
return JSON->new->encode( $value );
}
#-------------------------------------------------------------------
=head2 toHtml ( )
Renders an input tag of type text.
=cut
sub toHtml {
my $self = shift;
my $session = $self->session;
my ( $url, $style ) = $session->quick(qw( url style ));
my $value = $self->fixMacros($self->fixQuotes($self->fixSpecialCharacters($self->getOriginalValue)));
my $output = '';
# Table headers
$output .= '<table id="' . $self->get( 'id' ) . '"><thead><tr>';
for my $field ( @{ $self->get('fields') } ) {
$output .= '<th>' . $field->{label} . '</th>';
}
$output .= '<th>&nbsp;</th>'; # Extra column for buttons
# Buttons to add rows in the table footer
my $cols = scalar @{ $self->get('fields') } + 1; # Extra column for buttons
$output .= '</thead><tfoot><tr><td colspan="' . $cols . '">'
. '<button id="' . $self->get('id') . '_add">' . "Add" . '</button>'
. '</td></tr></tfoot>'
;
# Build a hidden row to copy for new rows
$output .= '<tbody><tr class="new_row" style="display: none">';
for my $field ( @{ $self->get('fields') } ) {
my $fieldName = join "_", $self->get('name'), $field->{name};
# Drawing using raw HTML to sanitize field HTML and allow future merging with DataTable
my $fieldHtml;
if ( $field->{type} eq "text" ) {
$fieldHtml = '<input type="text" name="' . $fieldName . '" size="' . $field->{size} . '" />';
}
elsif ( $field->{type} eq "select" ) {
$fieldHtml = '<select name="' . $fieldName . '" size="' . $field->{size} . '">';
my $opts = @{$field->{options}} / 2; # options is arrayref of name => label
for my $i ( 0 .. $opts-1 ) {
my $optValue = $field->{options}[$i*2];
my $optLabel = $field->{options}[$i*2+1];
$fieldHtml .= '<option value="' . $optValue . '">' . $optLabel . '</option>';
}
$fieldHtml .= '</select>';
}
elsif ( $field->{type} eq "id" ) {
$fieldHtml .= '<input type="hidden" class="jsontable_id" name="' . $fieldName . '" value="new" />';
}
else { # Readonly or unknown
$fieldHtml = '';
}
$output .= '<td>' . $fieldHtml . '</td>';
}
$output .= '</tr></tbody></table>';
# Build the existing rows
$output .= '<input type="hidden" name="' . $self->get('name') . '" value="' . $value . '" />';
# Existing rows are entirely built in javascript from the JSON in the hidden field
$style->setScript(
$url->extras('yui/build/yahoo-dom-event/yahoo-dom-event.js'),
{ type => 'text/javascript' },
);
$style->setScript(
$url->extras('yui/build/json/json-min.js'),
{ type => 'text/javascript' },
);
$output .= sprintf '<script src="%s" type="text/javascript"></script>',
$url->extras('yui-webgui/build/form/jsontable.js');
$output .= '<script type="text/javascript">'
. q{new WebGUI.Form.JsonTable("} . $self->get('name') . q{","} . $self->get( 'id' ) . q{");}
. '</script>';
return $output;
}
1;
#vim:ft=perl