webgui/lib/WebGUI/AssetHelper/CopyBranch.pm
Scott Walters b962b03848 Making the "Copy Branch" menu option work was a treat.
requestHelper() invokes an asset helper via AJAX.  processPlugin() handles the JSON responses, which in this case is to open a dialog box and show
a given URL in it (openDialog key in the JSON hash).  that pop-up is open and the page loaded, and that displays a form.  that form submits
to an asset helper (uh oh) which also returns JSON (actually, it was failing to do even that and was stringifying a hash).  even if it returned
JSON, it would just get shown to the user in the pop-up.  so the form that gets loaded into the pop-up has to, onsubmit, after it has config
details from the user, run JS to make the AJAX request to the asset helper to start the actual copy operation, call into the admin's JS to
pop up the dialog that polls on a forked process, and then call into the admin to close itself.  this is a nasty hack that daisy chains
together two possible replies to processPlugin(), one after the other.
2013-09-25 15:00:45 -05:00

212 lines
6.8 KiB
Perl

package WebGUI::AssetHelper::CopyBranch;
use strict;
use base qw/WebGUI::AssetHelper/;
use Scalar::Util qw{ blessed };
use WebGUI::VersionTag;
use JSON;
=head1 LEGAL
-------------------------------------------------------------------
WebGUI is Copyright 2001-2012 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
-------------------------------------------------------------------
=head1 NAME
Package WebGUI::AssetHelper::CopyBranch
=head1 DESCRIPTION
Copy an Asset to the Clipboard, with children or descendants
=head1 METHODS
These methods are available from this class:
=cut
#-------------------------------------------------------------------
=head2 process ()
Open a progress dialog for the copy operation
=cut
sub process {
my ($self) = @_;
return {
openDialog => $self->getUrl( 'getWith' ),
};
}
#----------------------------------------------------------------------------
=head2 www_getWith ()
Get the "with" configuration. "Descendants" or "Children".
=cut
sub www_getWith {
my ( $self ) = @_;
my $asset = $self->asset;
my $session = $self->session;
my $i18n = WebGUI::International->new($session, 'Asset');
my $copy_url = $self->getUrl( 'copy' ); # call this URL to start the copy; it returns a forkId
my $url = $self->session->url->page;
# XXX should probably be in a template
return qq{
<link rel="stylesheet" type="text/css" href="/extras/yui/build/button/assets/skins/sam/button.css" />
<link rel="stylesheet" type="text/css" href="/extras/yui/build/menu/assets/skins/sam/menu.css" />
<link rel="stylesheet" type="text/css" href="/extras/yui/build/container/assets/skins/sam/container.css" />
<link rel="stylesheet" type="text/css" href="/extras/admin/admin.css" />
<script type="text/javascript" src="/extras/yui/build/yahoo-dom-event/yahoo-dom-event.js"></script>
<script type="text/javascript" src="/extras/yui/build/utilities/utilities.js"></script>
<script type="text/javascript" src="/extras/yui/build/element/element-debug.js"></script>
<script type="text/javascript" src="/extras/yui/build/connection/connection-debug.js"></script>
<script type="text/javascript" src="/extras/yui/build/dragdrop/dragdrop-debug.js"></script>
<script type="text/javascript" src="/extras/yui/build/container/container-debug.js"></script>
<script type="text/javascript" src="/extras/yui/build/button/button-debug.js"></script>
<script type="text/javascript" src="/extras/yui/build/json/json-debug.js"></script>
<script type="text/javascript" src="/extras/yui/build/get/get-debug.js"></script>
<script type="text/javascript" src="/extras/yui/build/selector/selector-debug.js"></script>
<form action="$url" method="POST" enctype="multipart/form-data" onsubmit="do_submit(this); return false;">
<div><input type="submit" name="with" value="Children" /><!-- <script type="text/javascript">new YAHOO.widget.Button("with_formId");</script> --></div>
<div><input type="submit" name="with" id="with_formId" value="Descendants" /></div>
</form>
<script type="text/javascript">
function do_submit(form) {
var callback = {
success : function (o) {
var resp = YAHOO.lang.JSON.parse( o.responseText );
window.parent.admin.processPlugin(resp);
window.parent.admin.closeModalDialog();
},
failure : function (o) {
alert("Failed to fetch $copy_url: " + o.statusText);
console.error("Failed to fetch $copy_url: " + o.statusText);
},
cache: false
};
var url = "$copy_url";
var ajax = YAHOO.util.Connect.asyncRequest( 'GET', url, callback );
}
</script>
};
}
#----------------------------------------------------------------------------
=head2 www_copy ()
Perform the copy operation in a fork
=cut
sub www_copy {
my ($self) = @_;
my $asset = $self->asset;
my $session = $self->session;
my $childrenOnly = 1 if lc $session->form->get('with') eq 'children';
# Should we autocommit?
my $commit = $session->setting->get('versionTagMode') eq 'autoCommit';
# Fork the copy. Forking makes sure it won't get interrupted
my $fork = WebGUI::Fork->start(
$session, blessed( $self ), 'copyBranch', { childrenOnly => $childrenOnly, assetId => $asset->getId, commit => $commit },
);
return JSON->new->encode( {
forkId => $fork->getId,
} );
}
#-------------------------------------------------------------------
=head2 copyBranch ( $process, $args )
Perform the copy stuff in a forked process
=cut
sub copyBranch {
my ($process, $args) = @_;
my $session = $process->session;
my $asset = WebGUI::Asset->newById($session, $args->{assetId});
# Get the assets we need to duplicate
my $assetIds = [];
if ( $args->{childrenOnly} ) {
$assetIds = $asset->getLineage(['children']);
}
else {
$assetIds = $asset->getLineage(['descendants']);
}
my $tree = WebGUI::ProgressTree->new($session, $assetIds );
my $maxValue = keys %{ $tree->flat };
my $update_progress = sub {
# update the Fork's progress with how many are done
my $flat = $tree->flat;
my @done = grep { $_->{success} or $_->{failure} } values %$flat;
my $current_value = scalar @done;
my $info = {
maxValue => $maxValue,
value => $current_value,
message => 'Copying...',
reload => 1, # this won't take effect until Fork.pm returns finished => 1 and this status is propogated to WebGUI.Admin.prototype.openForkDialog's callback
@_,
};
$info->{refresh} = 1 if $maxValue == $current_value;
my $json = JSON::encode_json( $info );
$process->update( $json );
};
# Patch a sub to get a status update
my $patch = Monkey::Patch::patch_class(
'WebGUI::Asset',
'duplicate',
sub {
my ( $duplicate, $self, @args ) = @_;
my $id = $self->getId;
$tree->focus($id);
my $ret = $self->$duplicate(@args);
$tree->success($id);
$update_progress->();
return $ret;
}
);
my $newAsset = $asset->duplicateBranch( $args->{childrenOnly} ? 1 : 0, 'clipboard' );
$newAsset->update({ title => $newAsset->getTitle . ' (copy)'});
$tree->success($asset->getId);
$update_progress->();
my $tag = WebGUI::VersionTag->getWorking($session);
if ($tag->canAutoCommit) {
$tag->commit;
}
}
1;