History: PluginArchiveBuilder

Source of version: 30 (current)

! Plugin Archive Builder

Wikis are a great central repository for everyone to access the information. However, when used within the boundaries of an organization, it may be hard to provide only a portion of the information to an external group of people. Although it may be possible through assigning permissions, it still requires to grant them access to the wiki, provide them with accounts and walk them through the process of finding what they need. Just sending them a zip with the information they need might just be easier. This ((wiki plugin)), introduced in ((Tiki5)), does just that. Through arguments, it allows to define the content of an archive. Once rendered, it displays a __Download archive__ button to generate the archive on the fly.

{REMARKSBOX(type=info title="note")}
A new option to create PDF's from within Tiki was introduced and available in ((Tiki16)) based on a PHP library that works even on shared hosting without full root access. See ((mPDF))
{REMARKSBOX}

!! Requirements
The print as PDF mechanism uses the standard wiki print feature. However, the PDF generation is done through external HTML to PDF tools. These must be enabled and configured. Here are the alternatives. Chose one:
# ((wkhtmltopdf|Webkit wkhtmltopdf))
** Download wkhtmltopdf and place the executable somewhere on the host. Make sure it is executable from the web server.
** Set ''PDF from URL'' to ''Webkit'' (preference: print_pdf_from_url set to webkit)
** Set ''Webkit path'' to the full path to your executable. For example __/home/doc.tiki.org/webkit/wkhtmltopdf__.(preference: print_pdf_webkit_path)
# Webservice
** Set ''PDF from URL'' to ''Webservice'' (preference: print_pdf_from_url set to webservice)
** Set ''Webservice URL'' to the service location. The webservice must take the URL as the query string. A sample PHP script is available below. (preference: print_pdf_webservice_url)

{REMARKSBOX(type="tip" title="Note")}In version tiki<5.0, these preferences must be set directly in the database (do not forget to clear the cache to see them in tiki){REMARKSBOX}
{REMARKSBOX(type="tip" title="Note")}You may find these settings under Admin Home (tiki-admin.php), and then in the Configuration search box, enter "pdf" (no quotes).  After submitting, you will see "Not Found" next to each setting; ignore that (it is saying that the Admin Panel for that setting cannot be found). {REMARKSBOX}
^__Why is configuration required?__
wkhtmltopdf is written in C++ and there are different packages for Windows/Linux/MacOSX and thus it's better to install separately. 

Moreover, some servers may not allow shell execution, which is required. This can be worked around by installing it on a different server and accessing it remotely.^
!!Access rights
Because the content of the page is accessed through a URL, access rights must be managed correctly. If permissions protect the page from being visible to anonymous or plugins render it differently for them, an additional feature must be enabled.

The ((Token Access)) feature allows the archive builder to generate tokens bound to a specific URL. The PDF generator will then include the token as part of the URL. Doing so will grant the same groups to the PDF generator as the groups used by the archive requester. By default, the token will be available for 30 seconds.
!! Parameters
{pluginmanager plugin="archivebuilder"}
!! Body
The body of the plugin simply contains a list of rules to determine which file to create and where to take the content from. Each line is independent. Arguments are separated by colons. The first argument indicates how to treat the rest of the line. The following tokens may be used:
* __page-as-pdf__ to take render the content of a page as a pdf.
** First argument is the name and location of the PDF in the zip file.
** Second argument is the page name.
* __tracker-attachments__ to collect all attachments on a tracker item and store them in a folder.
** First argument is the name of the folder in which files will be added.
** Second argument is the ID of the tracker item.
* __tracker-files__ to collect all files, from the file gallery, on a tracker item and store them in folders.
** First argument is the name of the base folder in which files will be added, groupped in directories with the name of the field
** Second argument is the ID of the tracker item.
!!Example
{CODE(caption="Sample usage" colors="tiki")}
{ARCHIVEBUILDER(name=DF120-Summary.zip)}
page-as-pdf:DF120/Vision.pdf:VisionDF120
page-as-pdf:DF120/Team.pdf:TeamDF120
tracker-attachments:DF120/Requirements/:2232
{ARCHIVEBUILDER}
{CODE}

The output of the available plugin might look like:
* DF120-Summary.zip
** DF120/
*** Requirements/
**** performance.doc
**** mockup.png
*** Vision.pdf
*** Team.pdf
** manifest.txt ''(automatically generated, containing the list of files)''
!!! Sample webservice
{CODE(caption="generate_pdf.php" colors="php")}
<?php

$query = $_SERVER['QUERY_STRING'];

if( ! empty( $query ) ) {
        header( 'Content-Type: application/pdf' );
        $query = escapeshellarg( urldecode( $query ) );
        echo `../wkhtmltopdf-i386 $query -`;
}

?>
{CODE}

{include page="PDF related pages"}

-=Aliases=-
(alias(ArchiveBuilder)) | (alias(Archive Builder)) | (alias(Plugin Archive Builder)) | (alias(Plugin ArchiveBuilder))