Revision [3655]

This is an old revision of CloneHandler made by DarTar on 2004-12-25 18:38:42.

 

Cloning an existing WikiPage

Last edited by DarTar:
New CloneHandler with bugfixes/changes
Sat, 25 Dec 2004 18:38 UTC [diff]


I like to re-use and hate to redesign the wheel... Surely I'm not alone ;-)

Two solutions

Either an action CloneAction or this CloneHandler.
When the action was first published, DarTar explained that a handler would make more sense. It certainly is the right way to do so here is the handler.

Dependancy

This relies of the ExistsPage function developed by JavaWoman and part of release 1.1.6.0. You can find this version at WikkaDevelopment.

The code

Copy this code into a handler named: clone.php - place it in the handlers/page folder.
<div class="page">
<?php
/**
 * Clone a "template" page to a new named page
 *
 * Usage: type in /clone at the end of the URL you want to clone
 *
 * This handler checks the non existence of the page to be created, the user
 * right to read the template and the user right to create a page.
 * The editoption when true will create the new page and then open it for edition.
 *
 *
 * @package         Handlers
 * @subpackage        
 * @name              clone
 *
 * @author            {@link http://wikka.jsnx.com/ChristianBarthelemy Christian Barthelemy}
 * @version           0.2
 * @since             Wikka 1.1.6.x
 *                      
 * @input             string  $to  mandatory: the page to be created
 *                            must be a non existing page and current user must be authorized to create
 *
 * @input             string  $note  optional: the note to be added to the page when created
 *                            default is "Templated from " followed by the name of the template page
 *
 * @input             boolean $editoption optional: if true, the newly created page will be opened for edition
 *                            default is false
 */


 // ***** CONSTANTS *****
define ('USER_NAME',$this->GetUserName());
define ('BASE_URL',$this->config['base_url']);
// ***** END CONSTANTS *****

if ($_POST)
{
    // ***** GET PARAMETERS *****
    $from = $this->GetPageTag();
    $to = $_POST["to"];
    $note = $_POST["note"];
    $editoption = $_POST["editoption"];
    // ***** END PARAMETERS *****

    // ***** CLONING PROCESS *****
    If ($to<>"") {
        // The user must provide a WikiPage name to be created...
        if ($this->ExistsPage($to))
        {
            // and it should be a new one...
            $errormessage = "The destination page must not exist.";
            $this->SetMessage($errormessage);
            $this->Redirect($this->Href());
        }
        // also the user has to be allowed to create this page...
        elseif ($this->HasAccess("write", $to))
        {
            // The user should provide a WikiPage name to be duplicated...
            if ($from)
            {
                // the page to be duplicated must of course exit...
                if ($this->ExistsPage($from))
                {
                    // and the user has to be allowed to read it...
                    if (!$this->HasAccess("read", $from))
                    {
                        $errormessage = "You are not authorized to use the template page.";
                        $this->SetMessage($errormessage);
                        $this->Redirect($this->Href());
                    }
                }
                else
                {
                    // this is what happens if the user tries to duplicate a non existing page...
                    $errormessage = "The template page does not exist.";
                    $this->SetMessage($errormessage);
                    $this->Redirect($this->Href());
                }
            }
            // the user may provide a creation note otherwise...
            if (!$note)
            {
                // the system will create one by default...
                $note = "Templated from ".$from;
            }
       
            // ***** DERIVED VARIABLES *****
            $thepage=$this->LoadPage($from); // load the page that has to be duplicated...
            if ($thepage) $pagecontent = $thepage["body"]; // and get its content.
            // ***** END DERIVED VARIABLES *****
 
            // ***** OUTPUT SECTION *****
            $this->SavePage($to, $pagecontent, $note); // creates the page...
            $message=$to." has been created from ".$from." and note was: ".$note;
            if ($editoption)
            {
                $this->redirect(BASE_URL.$to."/edit"); // drops the user to the new page for edition if he choosed so...
            }
            else
            {
                $this->SetMessage($message);
                $this->Redirect($this->Href()); // ...or back where he comes from.
            }
            // ***** END OUTPUT SECTION *****

        } else
        {  
            // this is what happens if you try to create a page when you are not authorized.
            $errormessage = "You are not authorized to create the destination page.";
            $this->SetMessage($errormessage);
            $this->Redirect($this->Href());
        }
    }
    // ***** END TEMPLATING PROCESS *****
}
else
{
    // ***** INPUT FORM *****
    print $this->FormOpen("clone");
    echo '<table class="clone" border="1">';
    echo '  <tr>';
    echo '      <th align="left">WikiPage to be created:</th>';
    echo '          <td><input type="text" name="to" size="37">'.$to.'</td>';
    echo '  </tr>';
    echo '  <tr>';
    echo '      <th align="left">Added note to your edit:</th>';
    echo '          <td><input type="text" name="note" size="37">'.$note.'</td>';
    echo '  </tr>';
    echo '  <tr>';
    echo '      <th align="left">Do you want to edit the new page when created?</th>';
    echo '          <td>';
    echo '          <table border="1">';
    echo '              <tr>';
    echo '                  <td><input type="checkbox" name="editoption" value="false">Edit after creation'.$editoption.'</td>';
    echo '                  <td><input type="submit" name="create" value="Clone it now"></td>';
    echo '              </tr>';
    echo '          </table>';
    echo '          </td>';
    echo '  </tr>';
    echo '</table>';
    print $this->FormClose();
    // ***** END INPUT FORM *****
}
?>
</div>


How to use it?

Once you have (re)designed a page that fits to be replicated many times (Task Lists, User Pages, Bug Description, Developement Description...) you just have to type in /clone at the end of its URL.
Then you must fill the name of the new WikiPage to be created, you may want to add a note, finally you decide if you just want to create the page or if you want to jump and edit it as soon as it has been copied.

To Do

My code needs probably to be reviewed by expert coder as I am not at all a developper.
Any ideas around this handler more than welcome.

All discussions on this page still are at WikiTemplate. We definitely need a PageNameChange handler ;-)
See MovePages - not implemented, it has its problems; but the wish/requirement isn't new ;-) --JavaWoman


Improved CloneHandler


Christian, your code had a number of bugs that I've fixed in a new version of the handler that I've posted below.
I think this is an issue that should be addressed in general, not only in this case. We should try to produce an accessible code also for users whose browser does not support javascript. A central error handler, displaying alert messages (both local, as those produced by handlers and actions, and global, as those produced by the database or the engine itself), would be a major improvement of WikkaWiki.


I've uploaded this handler to the server so please test it and give your feedback here.
-- DarTar

<div class="page">
<?php
/**
 * Clones the current page and saves a copy of it as a new page.
 *
 * Usage: append /clone to the URL of the page you want to clone
 *
 * This handler checks the existence of the source page, the validity of the
 * name of the target page to be created, the user's read-access to the source
 * page and write-access to the target page.
 * If the edit option is selected, the user is redirected to the target page for
 * edition immediately after its creation.
 *
 * @package         Handlers
 * @subpackage        
 * @name              clone
 *
 * @author            {@link http://wikka.jsnx.com/ChristianBarthelemy Christian Barthelemy} - original idea and code.
 * @author            {@link http://wikka.jsnx.com/DarTar Dario Taraborelli} - bugs fixed, code improved, removed popup alerts.  
 * @version           0.3
 * @since             Wikka 1.1.6.x
 *                      
 * @input             string  $to  required: the page to be created
 *                            must be a non existing page and current user must be authorized to create
 *
 * @input             string  $note  optional: the note to be added to the page when created
 *                            default is "Cloned from " followed by the name of the source page
 *
 * @input             boolean $editoption optional: if true, the newly created page will be opened for edition
 *                            default is true
 * @todo              Use central function for valid pagenames.
 *        
 */


 // ***** SET DEFAULTS *****
$from = $this->tag;
$to = $this->tag;
$note = 'Cloned from '.$from; #i18n
$editoption = 'true';
$box = 'Please fill in a valid target ""PageName"" and an (optional) edit note.'; #i18n

// print header
echo $this->Format('==== Clone current page ====');

// 1. check source page existence
if (!$this->ExistsPage($from))
{
    // source page does not exist!
    $box = ' Sorry, page '.$from.' does not exist.'; #i18n
} else
{
    // 2. page exists - now check user's read-access to the source page
    if (!$this->HasAccess("read", $from))
    {
        // user can't read page!
        $box = ' //You aren not allowed to read the source of this page.//'; #i18n
    } else
    {
        // page exists and user has read-access to the source - proceed
        if ($_POST)
        {
            // get parameters
            $to = ($_POST["to"])? $_POST["to"] : $to;
            $note = ($_POST["note"])? $_POST["note"] : $note;
            $editoption = ($_POST["editoption"])? $_POST["editoption"] : $editoption;
       
            // 3. check target pagename validity
            if (!preg_match("/^[A-Z,a-z,ƒ÷‹,?‰ˆ¸]+[A-Z,a-z,0-9,ƒ÷‹,?‰ˆ¸]*$/s", $to))
            {
                // invalid pagename!
                $box = '""<div class="error">You must specify a valid PageName</div>""'; #i18n
            } else
            {
                // 4. target page name is valid - now check user's write-access
                if (!$this->HasAccess("write", $to))  
                {
                    $box = '""<div class="error">Sorry! You don\'t have write-access to '.$to.'</div>""'; #i18n
                } else
                {
                    // 5. check target page existence
                    if ($this->ExistsPage($to))
                    {
                        // page already exists!
                            $box = '""<div class="error">Sorry! The destination page already exists</div>""'; #i18n
                    } else
                    {
                        // 6. Valid request - proceed to page cloning
                        $thepage=$this->LoadPage($from); # load the source page
                        if ($thepage) $pagecontent = $thepage["body"]; # get its content
                        $this->SavePage($to, $pagecontent, $note); #create target page
                        if ($editoption == 'true')
                        {
                            $this->Redirect($this->href('edit',$to));
                        } else
                        {
                            $box = 'Page '.$to.' was succesfully created!'; #i18n
                        }
                    }
                }
            }
        }
        // build form
        $form = $this->FormOpen("clone");
        $form .= '<table class="clone">'.
            '<tr>'.
            '<td><strong>Clone '.$this->Link($this->GetPageTag()).' to:</strong></td>'.
            '<td><input type="text" name="to" value="'.$to.'" size="37" /></td>'.
            '</tr>'.
            '<tr>'.
            '<td><strong>Edit note:</strong></td>'.
            '<td><input type="text" name="note" value="'.$note.'" size="37" /></td>'.
            '</tr>'.
            '<tr>'.
            '<td></td>'.
            '<td>'.
            '<input type="checkbox" name="editoption" value="'.$editoption.'" /> Edit after creation '.
            '<input type="submit" name="create" value="Clone" />'.
            '</td>'.
            '</tr>'.
            '</table>';
        $form .= $this->FormClose();
    }
}

// display messages
if (isset($box)) echo $this->Format(" --- ".$box." --- --- ");
// print form
if (isset($form)) print $form;
?>
</div>





CategoryDevelopment
There are 14 comments on this page. [Show comments]
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki