The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Dancer2-Plugin-EditFile-0.005
River stage zero No dependents
/ Dancer2::Plugin::EditFile

NAME

Dancer2::Plugin::EditFile - Edit a text file from Dancer2

VERSION

Version 0.005

SYNOPSIS

  use Dancer2;
  use Dancer2::Plugin::EditFile;

DESCRIPTION

This plugin will allow you to retrieve a text file using Dancer2 and display it in an html page. Also, it will save the edited file to it's location on the server.

It's designed to be flexible and unobtrusive. It's behavior is customizable through Dancer's config file. ration file to activate or deactivate files that may be edited. Just include it in your Dancer2 script, set the configuration and use it.

NOTES:

    It is your responsibility to set security. So, be careful!!!

    There is a sample template in the sample folder.

CONFIGURATION

You may specify the routes and access to files. The plugin will only read/write files if it has access to them. The following configuration will generate two routes: '/editfile/display' and '/editfile/save'.

A sample HTML page with Bootstrap and jQuery is included in the samples directory. Use it as an example to build your own page.

  plugins:
    EditFile:
      backup:     1
      backup_dir: '/var/application/backups'
      display:
        method:    'get'
        route:     '/editfile/display'
        template:  'editfile.tt'
        layout:    'nomenu.tt'
      save:
        method:    'get'
        route:     '/editfile/save'
      files:
        id1:      
          heading: 'Edit Config.yml'
          file:    '/var/application/config.yml'
          save:    1
        id2:      
          heading:  'View config script config2'
          file:    '/var/application/config2.txt'
          save:    0
        id3:      
          heading: 'View XML file config3.xml'
          file:    '/var/application/config3.xml'
          save:    0

    Note the user must have read/write access to the file being edited and the backup directory.

backup

Specify if original file should be saved. Default = 0 (do not save)

backup_dir

Directory where original files should be saved. Default = /tmp

display

Defines display settings.

method

Default 'get'.

route

Route in Dancer to display template and file contents for editing/viewing. Default '/editfile/display'

template

Template cotaining edit/view form. Default 'editfile.tt'

layout

Layout of template. This is useful when opening a window to edit/view files.

Save
method

Default 'get'.

route
files

List of predefined files that may be edited/viewed.

file ids

A unique identifier for this file. It's used as part of the route to identify this file.

heading

This is a heading to be passed to the template. Use it as a short description to the file you're editing/viewing.

file

The file name on the drive.

save

Specifies if file may be saved. Default = 0 (view only)

AUTHOR

Hagop "Jack" Bilemjian, <jck000 at gmail.com>

BUGS

Please report any bugs or feature requests to bug-dancer2-plugin-editfile at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dancer2-Plugin-EditFile. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Dancer2::Plugin::EditFile

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2015-2017 Hagop "Jack" Bilemjian.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

SEE ALSO

Dancer2

Dancer2::Plugin