Attachment #114477 for bug #27251

View | Details | Raw Unified | Return to bug 27251
Collapse All | Expand All





=cut

=head3 to_api_mapping

This method returns the mapping for representing a Koha::Quote object
on the API.

=cut

sub to_api_mapping {
    return {
        id        => 'quote_id',
        source    => 'source',
        text      => 'text',
        timestamp => 'displayed_on',
    };
}

=head3 _type

=cut

    return 'Quote';
}

1;




package Koha::REST::V1::Quotes;

# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.

use Modern::Perl;

use Mojo::Base 'Mojolicious::Controller';

use Koha::Quotes;

use Try::Tiny;

=head1 API

=head2 Methods

=head3 list

=cut

sub list {
    my $c = shift->openapi->valid_input or return;

    return try {
        my $quotes_set = Koha::Quotes->new;
        my $quotes = $c->objects->search( $quotes_set );
        return $c->render( status => 200, openapi => $quotes );
    }
    catch {
        $c->unhandled_exception($_);
    };

}

=head3 get

=cut

sub get {
    my $c = shift->openapi->valid_input or return;

    return try {
        my $quote = Koha::Quotes->find( $c->validation->param('quote_id') );
        unless ($quote) {
            return $c->render( status  => 404,
                            openapi => { error => "quote not found" } );
        }

        return $c->render( status => 200, openapi => $quote->to_api );
    }
    catch {
        $c->unhandled_exception($_);
    }
}

=head3 add

=cut

sub add {
    my $c = shift->openapi->valid_input or return;

    return try {
        my $quote = Koha::Quote->new_from_api( $c->validation->param('body') );
        $quote->store;
        $c->res->headers->location( $c->req->url->to_string . '/' . $quote->id );
        return $c->render(
            status  => 201,
            openapi => $quote->to_api
        );
    }
    catch {
        $c->unhandled_exception($_);
    };
}

=head3 update

=cut

sub update {
    my $c = shift->openapi->valid_input or return;

    my $quote = Koha::Quotes->find( $c->validation->param('quote_id') );

    if ( not defined $quote ) {
        return $c->render( status  => 404,
                           openapi => { error => "Object not found" } );
    }

    return try {
        $quote->set_from_api( $c->validation->param('body') );
        $quote->store();
        return $c->render( status => 200, openapi => $quote->to_api );
    }
    catch {
        $c->unhandled_exception($_);
    };
}

=head3 delete

=cut

sub delete {
    my $c = shift->openapi->valid_input or return;

    my $quote = Koha::Quotes->find( $c->validation->param('quote_id') );
    if ( not defined $quote ) {
        return $c->render( status  => 404,
                           openapi => { error => "Object not found" } );
    }

    return try {
        $quote->delete;
        return $c->render(
            status  => 204,
            openapi => q{}
        );
    }
    catch {
        $c->unhandled_exception($_);
    };
}

1;

Lines 65-70 Link Here

(-)a/api/v1/swagger/definitions.json (+3 lines)
65	"patron_balance": {	65	"patron_balance": {
66	"$ref": "definitions/patron_balance.json"	66	"$ref": "definitions/patron_balance.json"
67	},	67	},
		68	"quote": {
		69	"$ref": "definitions/quote.json"
		70	},
68	"allows_renewal": {	71	"allows_renewal": {
69	"$ref": "definitions/allows_renewal.json"	72	"$ref": "definitions/allows_renewal.json"
70	},	73	},




{
  "type": "object",
  "properties": {
    "quote_id": {
      "$ref": "../x-primitives.json#/quote_id"
    },
    "source": {
      "description": "source of the quote",
      "type": "string"
    },
    "text": {
      "description": "text",
      "type": ["string", "null"]
    },
    "displayed_on": {
      "description": "Last display date",
      "type": ["string", "null"]
    }
  },
  "additionalProperties": false,
  "required": ["quote_id", "source", "text"]
}

Lines 32-37 Link Here

(-)a/api/v1/swagger/parameters.json (+3 lines)
32	"order_id_pp": {	32	"order_id_pp": {
33	"$ref": "parameters/order.json#/order_id_pp"	33	"$ref": "parameters/order.json#/order_id_pp"
34	},	34	},
		35	"quote_id_pp": {
		36	"$ref": "parameters/quote.json#/quote_id_pp"
		37	},
35	"smtp_server_id_pp": {	38	"smtp_server_id_pp": {
36	"$ref": "parameters/smtp_server.json#/smtp_server_id_pp"	39	"$ref": "parameters/smtp_server.json#/smtp_server_id_pp"
37	},	40	},

Line 0 Link Here

(-)a/api/v1/swagger/parameters/quote.json (+9 lines)
	1	{
	2	"quote_id_pp": {
	3	"name": "quote_id",
	4	"in": "path",
	5	"description": "Quote internal identifier",
	6	"required": true,
	7	"type": "integer"
	8	}
	9	}

Lines 134-139 Link Here

(-)a/api/v1/swagger/paths.json (+6 lines)
134	"/public/patrons/{patron_id}/guarantors/can_see_checkouts": {	134	"/public/patrons/{patron_id}/guarantors/can_see_checkouts": {
135	"$ref": "paths/public_patrons.json#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts"	135	"$ref": "paths/public_patrons.json#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts"
136	},	136	},
		137	"/quotes": {
		138	"$ref": "paths/quotes.json#/~1quotes"
		139	},
		140	"/quotes/{quote_id}": {
		141	"$ref": "paths/quotes.json#/~1quotes~1{quote_id}"
		142	},
137	"/return_claims": {	143	"/return_claims": {
138	"$ref": "paths/return_claims.json#/~1return_claims"	144	"$ref": "paths/return_claims.json#/~1return_claims"
139	},	145	},




{
  "/quotes": {
    "get": {
      "x-mojo-to": "Quotes#list",
      "operationId": "listQuotes",
      "tags": [
        "quotes"
      ],
      "produces": [
        "application/json"
      ],
      "parameters": [
        {
          "name": "quote_id",
          "in": "query",
          "description": "Case insensitive search on quote id",
          "required": false,
          "type": "string"
        },
        {
          "name": "source",
          "in": "query",
          "description": "Case insensitive search on source",
          "required": false,
          "type": "string"
        },
        {
          "name": "text",
          "in": "query",
          "description": "Case insensitive search on text",
          "required": false,
          "type": "string"
        },
        {
          "name": "displayed_on",
          "in": "query",
          "description": "Case Insensative search on last displayed date",
          "required": false,
          "type": "string"
        },
        {
          "$ref": "../parameters.json#/match"
        },
        {
          "$ref": "../parameters.json#/order_by"
        },
        {
          "$ref": "../parameters.json#/page"
        },
        {
          "$ref": "../parameters.json#/per_page"
        },
        {
          "$ref": "../parameters.json#/q_param"
        },
        {
          "$ref": "../parameters.json#/q_body"
        },
        {
          "$ref": "../parameters.json#/q_header"
        }
      ],
      "responses": {
        "200": {
          "description": "A list of quotes",
          "schema": {
            "type": "array",
            "items": {
              "$ref": "../definitions.json#/quote"
            }
          }
        },
        "403": {
          "description": "Access forbidden",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "500": {
          "description": "Internal error",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "503": {
          "description": "Under maintenance",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        }
      },
      "x-koha-authorization": {
        "permissions": {
          "catalogue": "1"
        }
      }
    },
    "post": {
      "x-mojo-to": "Quotes#add",
      "operationId": "addQuote",
      "tags": [
        "quotes"
      ],
      "parameters": [
        {
          "name": "body",
          "in": "body",
          "description": "A JSON object containing informations about the new quote",
          "required": true,
          "schema": {
            "$ref": "../definitions.json#/quote"
          }
        }
      ],
      "produces": [
        "application/json"
      ],
      "responses": {
        "201": {
          "description": "Quote added",
          "schema": {
            "$ref": "../definitions.json#/quote"
          }
        },
        "401": {
          "description": "Authentication required",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "403": {
          "description": "Access forbidden",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "500": {
          "description": "Internal error",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "503": {
          "description": "Under maintenance",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        }
      },
      "x-koha-authorization": {
        "permissions": {
          "tools": "edit_quotes"
        }
      }
    }
  },
  "/quotes/{quote_id}": {
    "get": {
      "x-mojo-to": "Quotes#get",
      "operationId": "getQuote",
      "tags": [
        "quotes"
      ],
      "parameters": [
        {
          "$ref": "../parameters.json#/quote_id_pp"
        }
      ],
      "produces": [
        "application/json"
      ],
      "responses": {
        "200": {
          "description": "A Quote",
          "schema": {
            "$ref": "../definitions.json#/quote"
          }
        },
        "404": {
          "description": "Quote not found",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "500": {
          "description": "Internal error",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "503": {
          "description": "Under maintenance",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        }
      },
      "x-koha-authorization": {
        "permissions": {
          "catalogue": "1"
        }
      }
    },
    "put": {
      "x-mojo-to": "Quotes#update",
      "operationId": "updateQuote",
      "tags": [
        "quotes"
      ],
      "parameters": [
        {
          "$ref": "../parameters.json#/quote_id_pp"
        },
        {
          "name": "body",
          "in": "body",
          "description": "a quote object",
          "required": true,
          "schema": {
            "$ref": "../definitions.json#/quote"
          }
        }
      ],
      "produces": [
        "application/json"
      ],
      "responses": {
        "200": {
          "description": "A quote",
          "schema": {
            "$ref": "../definitions.json#/quote"
          }
        },
        "401": {
          "description": "Authentication required",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "403": {
          "description": "Access forbidden",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "404": {
          "description": "Quote not found",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "500": {
          "description": "Internal error",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "503": {
          "description": "Under maintenance",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        }
      },
      "x-koha-authorization": {
        "permissions": {
          "tools": "edit_quotes"
        }
      }
    },
    "delete": {
      "x-mojo-to": "Quotes#delete",
      "operationId": "deleteQuote",
      "tags": [
        "quotes"
      ],
      "parameters": [
        {
          "$ref": "../parameters.json#/quote_id_pp"
        }
      ],
      "produces": [
        "application/json"
      ],
      "responses": {
        "204": {
          "description": "Quote deleted"
        },
        "401": {
          "description": "Authentication required",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "403": {
          "description": "Access forbidden",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "404": {
          "description": "Quote not found",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "500": {
          "description": "Internal error",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        },
        "503": {
          "description": "Under maintenance",
          "schema": {
            "$ref": "../definitions.json#/error"
          }
        }
      },
      "x-koha-authorization": {
        "permissions": {
          "tools": "edit_quotes"
        }
      }
    }
  }
}

Lines 52-57 Link Here

(-)a/api/v1/swagger/x-primitives.json (-1 / +5 lines)
52	"type": "integer",	52	"type": "integer",
53	"description": "internally assigned fund identifier",	53	"description": "internally assigned fund identifier",
54	"readOnly": true	54	"readOnly": true
		55	},
		56	"quote_id": {
		57	"type": "integer",
		58	"description": "internally assigned quote identifier",
		59	"readOnly": true
55	}	60	}
56
57	}	61	}




[% USE raw %]
[% USE Asset %]
[% SET footerjs = 1 %]
    [% INCLUDE 'doc-head-open.inc' %]
    <title>Koha &rsaquo; Tools &rsaquo; Quote uploader</title>
    [% INCLUDE 'doc-head-close.inc' %]
    [% Asset.css("css/uploader.css") | $raw %]
    [% Asset.css("css/quotes.css") | $raw %]
</head>

<body id="tools_quotes" class="tools">
[% INCLUDE 'header.inc' %]
[% INCLUDE 'cat-search.inc' %]

<div id="breadcrumbs"><a href="/cgi-bin/koha/mainpage.pl">Home</a> &rsaquo; <a href="/cgi-bin/koha/tools/tools-home.pl">Tools</a> &rsaquo; <a href="/cgi-bin/koha/tools/quotes.pl">Quote editor</a> &rsaquo; Quote uploader</div>

<div class="main container-fluid">
    <div class="row">
        <div class="col-sm-10 col-sm-push-2">
            <main>

                [% INCLUDE 'quotes-upload-toolbar.inc' %]
                <h2>Quote uploader</h2>
                <div id="instructions">
                <fieldset id="file_uploader_help" class="rows">
                    <legend>Instructions</legend>
                    <div id="file_uploader_inst">
                        <ul>
                        <li>The quote uploader accepts standard csv files with two columns: "source","text"</li>
                        <li>Click the "Choose File" button and select the csv file to be uploaded.</li>
                        <li>The file will be imported into an editable table for review prior to saving.</li>
                        </ul>
                    </div>
                    <div id="file_editor_inst">
                        <ul>
                        <li>Click on any field to edit the contents; Press the &lt;Enter&gt; key to save edit.</li>
                        <li>Click on one or more quote numbers to select entire quotes for deletion; Click the 'Delete Quote(s)' button to delete selected quotes.</li>
                        <li>Click the 'Save Quotes' button in the toolbar to save the entire batch of quotes.</li>
                        </ul>
                    </div>
                </fieldset>
                </div>
                <fieldset id="file_uploader" class="rows">
                    <legend>Upload quotes</legend>
                    <div id="file_upload">
                        <input type="file" name="file" />
                        <button id="cancel_upload" style="display:none">Cancel upload</button>
                        <div id="progress_bar"><div class="percent">0%</div></div>
                    </div>
                </fieldset>
                <table id="quotes_editor" style="visibility: hidden;">
                <thead>
                    <tr>
                        <th>Source</th>
                        <th>Text</th>
                        <th>Actions</th>
                    </tr>
                </thead>
                <tbody>
                    <!-- tbody content is generated by DataTables -->
                    <tr>
                        <td></td>
                        <td>Loading data...</td>
                        <td></td>
                    </tr>
                </tbody>
                </table>
                <fieldset id="footer" class="action" style="visibility: hidden;">
                </fieldset>

            </main>
        </div> <!-- /.col-sm-10.col-sm-push-2 -->

        <div class="col-sm-2 col-sm-pull-10">
            <aside>
                [% INCLUDE 'tools-menu.inc' %]
            </aside>
        </div> <!-- /.col-sm-2.col-sm-pull-10 -->
     </div> <!-- /.row -->

[% MACRO jsinclude BLOCK %]
    [% Asset.js("js/tools-menu.js") | $raw %]
    [% INCLUDE 'datatables.inc' %]
    [% Asset.js("lib/jquery/plugins/jquery.jeditable.mini.js") | $raw %]
    <script>
        var oTable; //DataTable object
        $(document).ready(function() {

            $("#cancel_upload").on("click",function(e){
                e.preventDefault();
                fnAbortRead();
            });
            $("#cancel_quotes").on("click",function(){
                return confirm( _("Are you sure you want to cancel this import?") );
            });

        // Credits:
        // FileReader() code copied and hacked from:
        // http://www.html5rocks.com/en/tutorials/file/dndfiles/
        // fnCSVToArray() gratefully borrowed from:
        // http://www.bennadel.com/blog/1504-Ask-Ben-Parsing-CSV-Strings-With-Javascript-Exec-Regular-Expression-Command.htm

        var reader;
        var progress = document.querySelector('.percent');
        $("#server_response").hide();

        function yuiGetData() {
            fnGetData(document.getElementById('quotes_editor'));
        }

        function fnAbortRead() {
            reader.abort();
        }

        function fnErrorHandler(evt) {
            switch(evt.target.error.code) {
                case evt.target.error.NOT_FOUND_ERR:
                    alert(_("File Not Found!"));
                    break;
                case evt.target.error.NOT_READABLE_ERR:
                    alert(_("File is not readable"));
                    break;
                case evt.target.error.ABORT_ERR:
                    break; // noop
                default:
                    alert(_("An error occurred reading this file."));
            };
        }

        function fnUpdateProgress(evt) {
            // evt is an ProgressEvent.
            if (evt.lengthComputable) {
                var percentLoaded = Math.round((evt.loaded / evt.total) * 100);
                // Increase the progress bar length.
                if (percentLoaded < 100) {
                    progress.style.width = percentLoaded + '%';
                    progress.textContent = percentLoaded + '%';
                }
            }
        }

        function fnCSVToArray( strData, strDelimiter ){
            // This will parse a delimited string into an array of
            // arrays. The default delimiter is the comma, but this
            // can be overriden in the second argument.

            // Check to see if the delimiter is defined. If not,
            // then default to comma.
            strDelimiter = (strDelimiter || ",");

            // Create a regular expression to parse the CSV values.
            var objPattern = new RegExp(
            (
                // Delimiters.
                "(\\" + strDelimiter + "|\\r?\\n|\\r|^)" +
                // Quoted fields.
                "(?:\"([^\"]*(?:\"\"[^\"]*)*)\"|" +
                // Standard fields.
                "([^\"\\" + strDelimiter + "\\r\\n]*))"
            ),
                "gi"
            );

            // Create an array to hold our data. Give the array
            // a default empty first row.
            var arrData = [[]];

            // Create an array to hold our individual pattern
            // matching groups.
            var arrMatches = null;

            // Keep looping over the regular expression matches
            // until we can no longer find a match.
            while (arrMatches = objPattern.exec( strData )){

                // Get the delimiter that was found.
                var strMatchedDelimiter = arrMatches[ 1 ];

                // Check to see if the given delimiter has a length
                // (is not the start of string) and if it matches
                // field delimiter. If it does not, then we know
                // that this delimiter is a row delimiter.
                if ( strMatchedDelimiter.length && (strMatchedDelimiter != strDelimiter) ){
                    // Since we have reached a new row of data,
                    // add an empty row to our data array.
                    // Note: if there is not more data, we will have to remove this row later
                    arrData.push( [] );
                }

                // Now that we have our delimiter out of the way,
                // let's check to see which kind of value we
                // captured (quoted or unquoted).
                if (arrMatches[ 2 ]){
                    // We found a quoted value. When we capture
                    // this value, unescape any double quotes.
                    var strMatchedValue = arrMatches[ 2 ].replace(
                    new RegExp( "\"\"", "g" ),
                        "\""
                    );
                } else if (arrMatches[3]){
                    // We found a non-quoted value.
                    var strMatchedValue = arrMatches[ 3 ];
                } else {
                    // There is no more valid data so remove the row we added earlier
                    // Is there a better way? Perhaps a look-ahead regexp?
                    arrData.splice(arrData.length-1, 1);
                }

                // Now that we have our value string, let's add
                // it to the data array.
                arrData[ arrData.length - 1 ].push( strMatchedValue );
            }

            // Return the parsed data.
            return( arrData );
        }

        function fnDataTable(aaData) {
            for(var i=0; i<aaData.length; i++) {
                aaData[i].unshift(i+1); // Add a column w/quote number
            }

            /* Transition from the quote file uploader to the quote file editor interface */
            $('#toolbar').css("visibility","visible");
            $('#toolbar').css("position","");
            $('#file_editor_inst').css("visibility", "visible");
            $('#file_editor_inst').css("position", "");
            $('#file_uploader_inst').css("visibility", "hidden");
            $('#save_quotes').css("visibility","visible");
            $('#file_uploader').css("visibility","hidden");
            $('#file_uploader').css("position","absolute");
            $('#file_uploader').css("top","-150px");
            $('#quotes_editor').css("visibility","visible");
            $("#save_quotes").on("click", yuiGetData);
            $("#delete_quote").on("click", fnClickDeleteRow);

            oTable = $('#quotes_editor').dataTable( {
                "bAutoWidth"        : false,
                "bPaginate"         : true,
                "bSort"             : false,
                "sPaginationType"   : "full_numbers",
                "sDom": '<"top pager"iflp>rt<"bottom pager"flp><"clear">',
                "aaData"            : aaData,
                "aoColumns"         : [
                    {
                        "sTitle"  : _("Number"),
                        "sWidth"  : "2%",
                    },
                    {
                        "sTitle"  : _("Source"),
                        "sWidth"  : "15%",
                    },
                    {
                        "sTitle"  : _("Quote"),
                        "sWidth"  : "83%",
                    },
                ],
               "fnPreDrawCallback": function(oSettings) {
                    return true;
                },
                "fnRowCallback": function( nRow, aData, iDisplayIndex ) {
                    /* do foo on various cells in the current row */
                    var quoteNum = $('td', nRow)[0].innerHTML;
                    $(nRow).attr("id", quoteNum); /* set row ids to quote number */
                    $('td:eq(0)', nRow).click(function() {$(this.parentNode).toggleClass('selected',this.clicked);}); /* add row selectors */
                    $('td:eq(0)', nRow).attr("title", _("Click ID to select/deselect quote"));
                    /* apply no_edit id to noEditFields */
                    noEditFields = [0]; /* number */
                    for (i=0; i<noEditFields.length; i++) {
                        $('td', nRow)[noEditFields[i]].setAttribute("id","no_edit");
                    }
                    return nRow;
                },
               "fnDrawCallback": function(oSettings) {
                    /* Apply the jEditable handlers to the table on all fields w/o the no_edit id */
                    $('#quotes_editor tbody td[id!="no_edit"]').editable( function(value, settings) {
                            var cellPosition = oTable.fnGetPosition( this );
                            oTable.fnUpdate(value, cellPosition[0], cellPosition[1], false, false);
                            return(value);
                        },
                        {
                        "callback"      : function( sValue, y ) {
                                              oTable.fnDraw(false); /* no filter/sort or we lose our pagination */
                                          },
                        "height"        : "14px",
                    });
               },
            });
            $('#footer').css("visibility","visible");
        }

        function fnHandleFileSelect(evt) {
            // Reset progress indicator on new file selection.
            progress.style.width = '0%';
            progress.textContent = '0%';

            reader = new FileReader();
            reader.onerror = fnErrorHandler;
            reader.onprogress = fnUpdateProgress;
            reader.onabort = function(e) {
                alert(_("File read cancelled"));
                parent.location='quotes-upload.pl';
            };
            reader.onloadstart = function(e) {
                $('#cancel_upload').show();
                $('#progress_bar').addClass("loading");
            };
            reader.onload = function(e) {
                // Ensure that the progress bar displays 100% at the end.
                progress.style.width = '100%';
                progress.textContent = '100%';
                $('#cancel_upload').hide();
                quotes = fnCSVToArray(e.target.result, ',');
                fnDataTable(quotes);
            }

            // perform various sanity checks on the target file prior to uploading...
            var fileType = evt.target.files[0].type || 'unknown';
            var fileSizeInK = Math.round(evt.target.files[0].size/1024);

            if (!fileType.match(/comma-separated-values|csv|excel|calc/i)) {
                alert(_("Uploads limited to csv. Incorrect filetype: %s").format(fileType));
                parent.location='quotes-upload.pl';
                return;
            }
            if (fileSizeInK > 512) {
                if (!confirm(_("%s %s KB Do you really want to upload this file?").format(evt.target.files[0].name, fileSizeInK))) {
                    parent.location='quotes-upload.pl';
                    return;
                }
            }
            // Read in the image file as a text string.
            reader.readAsText(evt.target.files[0]);
        }

        $('#file_upload').one('change', fnHandleFileSelect);

        });

        function fnGetData(element) {
            var jqXHR = $.ajax({
                url         : "/cgi-bin/koha/tools/quotes/quotes-upload_ajax.pl",
                type        : "POST",
                contentType : "application/x-www-form-urlencoded", // we must claim this mimetype or CGI will not decode the URL encoding
                dataType    : "json",
                data        : {
                                "quote"     : encodeURI ( JSON.stringify(oTable.fnGetData()) ),
                                "action"    : "add",
                              },
                success     : function(){
                    var response = JSON.parse(jqXHR.responseText);
                    if (response.success) {
                        alert(_("%s quotes saved.").format(response.records));
                        window.location.reload(true);   // is this the best route?
                    } else {
                        alert(_("%s quotes saved, but an error has occurred. Please ask your administrator to check the server log for more details.").format(response.records));
                        window.location.reload(true);   // is this the best route?
                    }
                  },
            });
        }

        function fnClickDeleteRow() {
            var idsToDelete = oTable.$('.selected').map(function() {
                  return this.id;
            }).get().join(', ');
            if (!idsToDelete) {
                alert(_("Please select a quote(s) by clicking the quote id(s) you desire to delete."));
            }
            else if (confirm(_("Are you sure you wish to delete quote(s) %s?").format(idsToDelete))) {
                oTable.$('.selected').each(function(){
                    oTable.fnDeleteRow(this);
                });
            }
        }
    </script>
[% END %]

[% INCLUDE 'intranet-bottom.inc' %]




[% USE raw %]
[% USE Asset %]
[% SET footerjs = 1 %]
[% INCLUDE 'doc-head-open.inc' %]
<title>Koha &rsaquo; Tools &rsaquo; Quote editor</title>
[% INCLUDE 'doc-head-close.inc' %]
[% Asset.css("css/quotes.css") | $raw %]
</head>

<body id="tools_quotes" class="tools">

        <div class="col-sm-10 col-sm-push-2">
            <main>

[% FOREACH m IN messages %]
    <div class="dialog [% m.type | html %]" id="quote_action_result_dialog">
        [% SWITCH m.code %]
        [% CASE 'error_on_update' %]
            An error occurred when updating this quote. Perhaps it already exists.
        [% CASE 'error_on_insert' %]
            An error occurred when adding this quote.
        [% CASE 'success_on_update' %]
            Quote updated successfully.
        [% CASE 'success_on_insert' %]
            Quote added successfully.
        [% CASE %]
            [% m.code | html %]
        [% END %]
    </div>
[% END %]

    <div class="dialog message" id="quote_delete_success" style="display: none;"></div>
    <div class="dialog alert"   id="quote_delete_error"   style="display: none;"></div>

[% IF op == 'list' %]
    <div id="toolbar" class="btn-toolbar">
        <a class="btn btn-default" id="newquote" href="/cgi-bin/koha/tools/quotes.pl?op=add_form"><i class="fa fa-plus"></i> New Quote</a>
    </div>
[% END %]

[% IF op == 'add_form' %]
    <h3>[% IF quote %]Modify quote[% ELSE %]New quote[% END %]</h3>
    <form action="/cgi-bin/koha/tools/quotes.pl" id="Aform" name="Aform" class="validated" method="post">
        <fieldset class="rows">
            <input type="hidden" name="op" value="add_validate" />
            <ol>
                <li>
                    <label for="text" class="required">Source: </label>
                    <input type="text" name="source" id="source" value="[% quote.source | html %]" class="required" required="required" />
                    <span class="required">Required</span>
                </li>
                <li>
                    <label for="text" class="required">text: </label>
                    <textarea name="text" id="text" class="required" required="required" />[% quote.text | html %]</textarea>
                    <span class="required">Required</span>
                </li>
            </ol>
        </fieldset>
        <fieldset class="action">
            <input type="hidden" name="id" value="[% quote.id %]" />
            <input type="submit" value="Submit" />
            <a class="cancel" href="/cgi-bin/koha/tools/quotes.pl">Cancel</a>
        </fieldset>
    </form>
[% END %]

[% IF op == 'delete_confirm' %]
    <div class="dialog alert">
        <form action="/cgi-bin/koha/tools/quotes.pl" method="post">
            <h3>Are you sure you want to delete the following quote?</h3>
            [% quote.source | html %] - [% quote.text | html %]
            <input type="hidden" name="op" value="delete_confirmed" />
            <input type="hidden" name="id" value="[% quote.id | html %]" />
            <button type="submit" class="approve"><i class="fa fa-fw fa-check"></i> Yes, delete</button>
        </form>
        <form action="/cgi-bin/koha/tools/quotes.pl" method="get">
            <button type="submit" class="deny"><i class="fa fa-fw fa-remove"></i> No, do not delete</button>
        </form>
    </div>
[% END %]

[% IF op == 'list' %]
    <h3>Quotes</h3>
    [% IF quotes_count > 0 %]
        <table id="quotes">
            <thead>
                <tr>
                    <th>ID</th>
                    <th>Source</th>
                    <th>Text</th>
                    <th>Last display</th>
                    <th data-class-name="actions">Actions</th>
                </tr>
            </thead>
        </table>
    [% ELSE %]
        <div class="dialog message">There are no quotes defined. <a href="/cgi-bin/koha/tools/quotes.pl?op=add_form">Start defining quotes</a>.</div>
    [% END %]

    <div id="delete_confirm_modal" class="modal" tabindex="-1" role="dialog" aria-labelledby="delete_confirm_modal_label" aria-hidden="true">
        <div class="modal-dialog">
            <div class="modal-content">
                <div class="modal-header">
                    <button type="button" class="closebtn" data-dismiss="modal" aria-hidden="true">×</button>
                    <h3 id="delete_confirm_modal_label">Delete quote</h3>
                </div>
                <div class="modal-body">
                    <div id="delete_confirm_dialog"></div>
                </div>
                <div class="modal-footer">
                    <a href="#" class="btn btn-default" id="delete_confirm_modal_button" role="button" data-toggle="modal">Delete</a>
                    <button class="btn btn-default" data-dismiss="modal" aria-hidden="true">Close</button>
                </div>
            </div> <!-- /.modal-content -->
        </div> <!-- /.modal-dialog -->
    </div> <!-- #delete_confirm_modal -->
[% END %]
                    <tr>
                        <td></td>
                        <td></td>
                        <td>Loading data...</td>
                        <td></td>
                    </tr>
                </tbody>
                </table>
                <fieldset id="footer" class="action">
                </fieldset>

            </main>
        </div> <!-- /.col-sm-10.col-sm-push-2 -->


[% MACRO jsinclude BLOCK %]
    [% Asset.js("js/tools-menu.js") | $raw %]
    [% INCLUDE 'js-date-format.inc' %]
    [% INCLUDE 'datatables.inc' %]

    [% Asset.js("lib/jquery/plugins/jquery.jeditable.mini.js") | $raw %]
    <script>
        var oTable; /* oTable needs to be global */
        var sEmptyTable = _("No quotes available. Please use the 'Add quote' button to add a quote."); /* override the default message in datatables.inc */
        $(document).ready(function() {

            var quotes_url = '/api/v1/quotes';
            var quotes = $("#quotes").api({
                "ajax": {
                    "url": quotes_url
                "bPaginate"         : true,
                "sPaginationType"   : "full_numbers",
                "sDom": '<"top pager"iflp>rt<"bottom pager"flp><"clear">',
                "sAjaxSource"       : "/cgi-bin/koha/tools/quotes/quotes_ajax.pl",
                "aoColumns"         : [
                                        { "sWidth": "3%"  },
                                        { "sWidth": "11%" },
                                        { "sWidth": "75%" },
                                        { "sWidth": "11%" },
                                      ],
               "oLanguage": dataTablesDefaults.oLanguage,
               "fnPreDrawCallback": function(oSettings) {
                    return true;
                },
                'emptyTable': '<div class="dialog message">'+_("There are no quotes defined.")+' <a href="/cgi-bin/koha/tools/quotes.pl?op=add_form">'+_("Start defining quotes")+'</a>.</div>',
                "columnDefs": [ {
                    "targets": [0,1,2,3],
                    "render": function (data, type, row, meta) {
                        if ( type == 'display' ) {
                            if ( data != null ) {
                                return data.escapeHtml();
                            }
                            else {
                                return "";
                            }
                        }
                        return data;
                    /* apply no_edit id to noEditFields */
                    for (i=0; i<noEditFields.length; i++) {
                        $('td', nRow)[noEditFields[i]].setAttribute("id","no_edit");
                    }
                } ],
                "columns": [
                    {
                        "data": "quote_id",
                        "searchable": true,
                        "orderable": true
                    },
                    {
                        "data": "source",
                        "searchable": true,
                        "orderable": true
                    },
                    {
                        "data": "text",
                        "searchable": true,
                        "orderable": true
                    },
                    {
                        "data": function( row, type, val, meta ) {
                            return $datetime(row.displayed_on);
                        },
                        "searchable": true,
                        "orderable": true
                    },
                    {
                        "data": function( row, type, val, meta ) {
            });
        });

                            var result = '<a class="btn btn-default btn-xs" href="/cgi-bin/koha/tools/quotes.pl?op=add_form&amp;id='+encodeURIComponent(row.quote_id)+'" role="button"><i class="fa fa-pencil" aria-hidden="true"></i> '+_("Edit")+'</a>';
                            result += '<form action="/cgi-bin/koha/tools/quotes.pl" method="post">';
                            result += '<input type="hidden" name="id" value="'+row.quote_id.escapeHtml()+'" />'+"\n";

                            result += '<a class="btn btn-default btn-xs delete_quote" role="button" href="#" data-toggle="modal" data-target="#delete_confirm_modal" data-quote-id="'+ encodeURIComponent(row.quote_id) +'"><i class="fa fa-trash" aria-hidden="true"></i>'+_("Delete")+'</a>';

                            return result;
                var quoteSource = $('#quoteSource').val();
                var quoteText = $('#quoteText').val()
                /* If passed a quote source, add the quote to the db */
                if (quoteSource && quoteText) {
                    $.ajax({
                        url: "/cgi-bin/koha/tools/quotes/quotes_ajax.pl",
                        type: "POST",
                        data: {
                            "source"    : quoteSource,
                            "text"      : quoteText,
                            "action"    : "add",
                        },
                        "searchable": false,
                        "orderable": false
                    },
                ]
            });

            $('#quotes').on( "click", '.delete_quote', function () {
                var quote_id   = decodeURIComponent($(this).data('quote-id'));

                $("#delete_confirm_dialog").html(
                    _("You are about to delete the quote #%s.").format(quote_id)
                );

                $("#delete_confirm_modal_button").unbind("click").on( "click", function () {
                    alert(_("Please supply both the text and source of the quote before saving."));
                }
            } else if (e.keyCode == 27) {
                if (confirm(_("Are you sure you want to cancel adding this quote?"))) {
                    oTable.fnDeleteRow(node);
                } else {
                    return;
                }
            }
        }

        function fnClickAddRow() {
            $('.add_quote_button').removeAttr('onclick'); // disable add button once it has been clicked
            var aRow = oTable.fnAddData(
                [
                    'NA', // this is hackish to fool the datatable sort routine into placing this row at the end of the list...
                    '<input id="quoteSource" type="text" style="width:99%" onkeydown="fnClickAddQuote(event,this.parentNode.parentNode)"/>',
                    '<input id="quoteText" type="text" style="width:99%" onkeydown="fnClickAddQuote(event,this.parentNode.parentNode)"/>',
                    '0000-00-00 00:00:00',
                ],
                false
            );
            oTable.fnPageChange( 'last' );
            $('#quoteSource').focus();
        }

        function fnClickDeleteRow() {
            var idsToDelete = oTable.$('.selected').map(function() {
                  return this.id;
            }).get().join(', ');
            if (!idsToDelete) {
                alert(_("Please select a quote(s) by clicking the quote id(s) you desire to delete."));
            } else if (confirm(_("Are you sure you wish to delete quote(s) %s?").format(idsToDelete))) {
                oTable.$('.selected').each(function(){
                    var quoteID = $(this).attr('id');
                    $.ajax({
                        method: "DELETE",
                        url: "/api/v1/quotes/"+quote_id
                    }).success(function() {
                        $("#delete_confirm_modal").modal('hide');
                        quotes.api().ajax.reload(function (data) {
                            if (data.recordsTotal == 0) {
                                $("#quotes").hide();
                            }
                            $("#quote_action_result_dialog").hide();
                            $("#quote_delete_success").html(_("Quote #%s deleted successfully.").format(quote_id)).show();
                        });
                    }).error(function () {
                        $("#quote_delete_error").html(_("Error deleting quote #%s. Check the logs.").format(quote_id)).show();
                    });
                });
            });

        });
        }
    </script>
[% END %]





#!/usr/bin/perl

# Copyright 2012 Foundations Bible College Inc.
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.

use Modern::Perl;

use CGI qw ( -utf8 );
use autouse 'Data::Dumper' => qw(Dumper);

use C4::Auth;
use C4::Koha;
use C4::Context;
use C4::Output;

my $cgi = CGI->new;

my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
    {
        template_name   => "tools/quotes-upload.tt",
        query           => $cgi,
        type            => "intranet",
        flagsrequired   => { tools => 'edit_quotes' },
        debug           => 1,
    }
);

output_html_with_http_headers $cgi, $cookie, $template->output;




#!/usr/bin/perl

# Copyright 2012 Foundations Bible College Inc.
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it

use Modern::Perl;

use CGI qw ( -utf8 );
use Try::Tiny;

use C4::Auth;
use C4::Koha;
use C4::Context;
use C4::Output;
use Koha::Quotes;

my $input = CGI->new;

my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
    {
        template_name => "tools/quotes.tt",
        query         => $input,
        type          => "intranet",
        flagsrequired => { tools => 'edit_quotes' },
        debug         => 1,
    }
);

my $id = $input->param('id');
my $op = $input->param('op') || 'list';
my @messages;

if ( $op eq 'add_form' ) {
    $template->param( quote => Koha::Quotes->find($id), );
}
elsif ( $op eq 'add_validate' ) {
    my @fields = qw(
      source
      text
    );

    if ($id) {
        my $quote = Koha::Quotes->find($id);
        for my $field (@fields) {
            $quote->$field( scalar $input->param($field) );
        }

        try {
            $quote->store;
            push @messages, { type => 'message', code => 'success_on_update' };
        }
        catch {
            push @messages, { type => 'alert', code => 'error_on_update' };
        }
    }
    else {
        my $quote = Koha::Quote->new(
            {
                id => $id,
                ( map { $_ => scalar $input->param($_) || undef } @fields )
            }
        );

        try {
            $quote->store;
            push @messages, { type => 'message', code => 'success_on_insert' };
        }
        catch {
            push @messages, { type => 'alert', code => 'error_on_insert' };
        };
    }
    $op = 'list';
}
else {
    $op = 'list';
}

$template->param( quotes_count => Koha::Quotes->search->count )
  if $op eq 'list';

$template->param(
    messages => \@messages,
    op       => $op,
);

output_html_with_http_headers $input, $cookie, $template->output;




#!/usr/bin/perl

# Copyright 2012 Foundations Bible College Inc.
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.

use Modern::Perl;

use CGI qw ( -utf8 );
use JSON;
use URI::Escape;
use autouse 'Data::Dumper' => qw(Dumper);

use C4::Auth;
use C4::Koha;
use C4::Context;
use C4::Output;

my $cgi = CGI->new;
my $dbh = C4::Context->dbh;

my ( $status, $cookie, $sessionID ) = C4::Auth::check_api_auth( $cgi, { tools => 'edit_quotes' } );
unless ($status eq "ok") {
    print $cgi->header(-type => 'application/json', -status => '403 Forbidden');
    print to_json({ auth_status => $status });
    exit 0;
}

my $success = 'true';
my $quotes_tmp = uri_unescape( $cgi->param('quote' ) );
my $quotes = decode_json( $quotes_tmp );

my $action = $cgi->param('action');

my $sth = $dbh->prepare('INSERT INTO quotes (source, text) VALUES (?, ?);');

my $insert_count = 0;

foreach my $quote (@$quotes) {
    $insert_count++ if $sth->execute($quote->[1], $quote->[2]);
    if ($sth->err) {
        warn sprintf('Database returned the following error: %s', $sth->errstr);
        $success = 'false';
    }
}

print $cgi->header('application/json');

print to_json({
                success => $success,
                records => $insert_count,
});




#!/usr/bin/perl

# Copyright 2012 Foundations Bible College Inc.
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.

use Modern::Perl;

use CGI qw ( -utf8 );
use JSON;
use autouse 'Data::Dumper' => qw(Dumper);

use C4::Auth;
use C4::Context;

my $cgi = CGI->new;
my $dbh = C4::Context->dbh;
my $sort_columns = ["id", "source", "text", "timestamp"];

my ( $status, $cookie, $sessionID ) = C4::Auth::check_api_auth( $cgi, { tools => 'edit_quotes' } );
unless ($status eq "ok") {
    print $cgi->header(-type => 'application/json', -status => '403 Forbidden');
    print to_json({ auth_status => $status });
    exit 0;
}

# NOTE: This is a collection of ajax functions for use with tools/quotes.pl

my $params = $cgi->Vars; # NOTE: Multivalue parameters NOT allowed!!

print $cgi->header('application/json; charset=utf-8');

my $action = $params->{'action'} || 'get';
if ($action eq 'add') {
    my $sth = $dbh->prepare('INSERT INTO quotes (source, text) VALUES (?, ?);');
    $sth->execute($params->{'source'}, $params->{'text'});
    if ($sth->err) {
        warn sprintf('Database returned the following error: %s', $sth->errstr);
        exit 0;
    }
    my $new_quote_id = $dbh->{q{mysql_insertid}}; # ALERT: mysqlism here
    $sth = $dbh->prepare('SELECT * FROM quotes WHERE id = ?;');
    $sth->execute($new_quote_id);
    print to_json($sth->fetchall_arrayref, {utf8 =>1});
    exit 0;
}
elsif ($action eq 'edit') {
    my $aaData = [];
    my $editable_columns = [qw(source text)]; # pay attention to element order; these columns match the quotes table columns
    my $sth = $dbh->prepare("UPDATE quotes SET $editable_columns->[$params->{'column'}-1]  = ? WHERE id = ?;");
    $sth->execute($params->{'value'}, $params->{'id'});
    if ($sth->err) {
        warn sprintf('Database returned the following error: %s', $sth->errstr);
        exit 1;
    }
    $sth = $dbh->prepare("SELECT $editable_columns->[$params->{'column'}-1] FROM quotes WHERE id = ?;");
    $sth->execute($params->{'id'});
    $aaData = $sth->fetchrow_array();
    print Encode::encode('utf8', $aaData);

    exit 0;
}
elsif ($action eq 'delete') {
    my $sth = $dbh->prepare("DELETE FROM quotes WHERE id = ?;");
    $sth->execute($params->{'id'});
    if ($sth->err) {
        warn sprintf('Database returned the following error: %s', $sth->errstr);
        exit 1;
    }
    exit 0;
}
else {
    my $aaData = [];
    my $iTotalRecords = '';
    my $sth = '';

    $iTotalRecords = $dbh->selectrow_array('SELECT count(*) FROM quotes;');
    $sth = $dbh->prepare("SELECT * FROM quotes;");

    $sth->execute();
    if ($sth->err) {
        warn sprintf('Database returned the following error: %s', $sth->errstr);
        exit 1;
    }

    $aaData = $sth->fetchall_arrayref;
    my $iTotalDisplayRecords = $iTotalRecords; # no filtering happening here


    print to_json({
                    iTotalRecords       =>  $iTotalRecords,
                    iTotalDisplayRecords=>  $iTotalDisplayRecords,
                    sEcho               =>  $params->{'sEcho'},
                    aaData              =>  $aaData,
                  }, {utf8 =>1});
}
- 

Return to bug 27251

Lines 33-38 Koha::Quote - Koha Quote object class Link Here

(-)a/Koha/Quote.pm (-1 / +17 lines)
33		33
34	=cut	34	=cut
35		35
		36	=head3 to_api_mapping
		37
		38	This method returns the mapping for representing a Koha::Quote object
		39	on the API.
		40
		41	=cut
		42
		43	sub to_api_mapping {
		44	return {
		45	id => 'quote_id',
		46	source => 'source',
		47	text => 'text',
		48	timestamp => 'displayed_on',
		49	};
		50	}
		51
36	=head3 _type	52	=head3 _type
37		53
38	=cut	54	=cut
Lines 41-44 sub _type { Link Here
41	return 'Quote';	57	return 'Quote';
42	}	58	}
43		59
44	1;	60	1;

Line 0 Link Here

(-)a/Koha/REST/V1/Quotes.pm (+139 lines)
		1	package Koha::REST::V1::Quotes;
		2
		3	# This file is part of Koha.
		4	#
		5	# Koha is free software; you can redistribute it and/or modify it
		6	# under the terms of the GNU General Public License as published by
		7	# the Free Software Foundation; either version 3 of the License, or
		8	# (at your option) any later version.
		9	#
		10	# Koha is distributed in the hope that it will be useful, but
		11	# WITHOUT ANY WARRANTY; without even the implied warranty of
		12	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		13	# GNU General Public License for more details.
		14	#
		15	# You should have received a copy of the GNU General Public License
		16	# along with Koha; if not, see <http://www.gnu.org/licenses>.
		17
		18	use Modern::Perl;
		19
		20	use Mojo::Base 'Mojolicious::Controller';
		21
		22	use Koha::Quotes;
		23
		24	use Try::Tiny;
		25
		26	=head1 API
		27
		28	=head2 Methods
		29
		30	=head3 list
		31
		32	=cut
		33
		34	sub list {
		35	my $c = shift->openapi->valid_input or return;
		36
		37	return try {
		38	my $quotes_set = Koha::Quotes->new;
		39	my $quotes = $c->objects->search( $quotes_set );
		40	return $c->render( status => 200, openapi => $quotes );
		41	}
		42	catch {
		43	$c->unhandled_exception($_);
		44	};
		45
		46	}
		47
		48	=head3 get
		49
		50	=cut
		51
		52	sub get {
		53	my $c = shift->openapi->valid_input or return;
		54
		55	return try {
		56	my $quote = Koha::Quotes->find( $c->validation->param('quote_id') );
		57	unless ($quote) {
		58	return $c->render( status => 404,
		59	openapi => { error => "quote not found" } );
		60	}
		61
		62	return $c->render( status => 200, openapi => $quote->to_api );
		63	}
		64	catch {
65	$c->unhandled_exception($_);
66	}
67	}
68
69	=head3 add
70
71	=cut
72
73	sub add {
74	my $c = shift->openapi->valid_input or return;
75
76	return try {
77	my $quote = Koha::Quote->new_from_api( $c->validation->param('body') );
78	$quote->store;
79	$c->res->headers->location( $c->req->url->to_string . '/' . $quote->id );
80	return $c->render(
81	status => 201,
82	openapi => $quote->to_api
83	);
84	}
85	catch {
86	$c->unhandled_exception($_);
87	};
88	}
89
90	=head3 update
91
92	=cut
93
94	sub update {
95	my $c = shift->openapi->valid_input or return;
96
97	my $quote = Koha::Quotes->find( $c->validation->param('quote_id') );
98
99	if ( not defined $quote ) {
100	return $c->render( status => 404,
101	openapi => { error => "Object not found" } );
102	}
103
104	return try {
105	$quote->set_from_api( $c->validation->param('body') );
106	$quote->store();
107	return $c->render( status => 200, openapi => $quote->to_api );
108	}
109	catch {
110	$c->unhandled_exception($_);
111	};
112	}
113
114	=head3 delete
115
116	=cut
117
118	sub delete {
119	my $c = shift->openapi->valid_input or return;
120
121	my $quote = Koha::Quotes->find( $c->validation->param('quote_id') );
122	if ( not defined $quote ) {
123	return $c->render( status => 404,
124	openapi => { error => "Object not found" } );
125	}
126
127	return try {
128	$quote->delete;
129	return $c->render(
130	status => 204,
131	openapi => q{}
132	);
133	}
134	catch {
135	$c->unhandled_exception($_);
136	};
137	}
138
139	1;

Line 0 Link Here

(-)a/api/v1/swagger/definitions/quote.json (+22 lines)
	1	{
	2	"type": "object",
	3	"properties": {
	4	"quote_id": {
	5	"$ref": "../x-primitives.json#/quote_id"
	6	},
	7	"source": {
	8	"description": "source of the quote",
	9	"type": "string"
	10	},
	11	"text": {
	12	"description": "text",
	13	"type": ["string", "null"]
	14	},
	15	"displayed_on": {
	16	"description": "Last display date",
	17	"type": ["string", "null"]
	18	}
	19	},
	20	"additionalProperties": false,
	21	"required": ["quote_id", "source", "text"]
	22	}

Line 0 Link Here

(-)a/api/v1/swagger/paths/quotes.json (+327 lines)
		1	{
		2	"/quotes": {
		3	"get": {
		4	"x-mojo-to": "Quotes#list",
		5	"operationId": "listQuotes",
		6	"tags": [
		7	"quotes"
		8	],
		9	"produces": [
		10	"application/json"
		11	],
		12	"parameters": [
		13	{
		14	"name": "quote_id",
		15	"in": "query",
		16	"description": "Case insensitive search on quote id",
		17	"required": false,
		18	"type": "string"
		19	},
		20	{
		21	"name": "source",
		22	"in": "query",
		23	"description": "Case insensitive search on source",
		24	"required": false,
		25	"type": "string"
		26	},
		27	{
		28	"name": "text",
		29	"in": "query",
		30	"description": "Case insensitive search on text",
		31	"required": false,
		32	"type": "string"
		33	},
		34	{
		35	"name": "displayed_on",
		36	"in": "query",
		37	"description": "Case Insensative search on last displayed date",
		38	"required": false,
		39	"type": "string"
		40	},
		41	{
		42	"$ref": "../parameters.json#/match"
		43	},
		44	{
		45	"$ref": "../parameters.json#/order_by"
		46	},
		47	{
		48	"$ref": "../parameters.json#/page"
		49	},
		50	{
		51	"$ref": "../parameters.json#/per_page"
		52	},
		53	{
		54	"$ref": "../parameters.json#/q_param"
		55	},
		56	{
		57	"$ref": "../parameters.json#/q_body"
		58	},
		59	{
		60	"$ref": "../parameters.json#/q_header"
		61	}
		62	],
		63	"responses": {
		64	"200": {
65	"description": "A list of quotes",
66	"schema": {
67	"type": "array",
68	"items": {
69	"$ref": "../definitions.json#/quote"
70	}
71	}
72	},
73	"403": {
74	"description": "Access forbidden",
75	"schema": {
76	"$ref": "../definitions.json#/error"
77	}
78	},
79	"500": {
80	"description": "Internal error",
81	"schema": {
82	"$ref": "../definitions.json#/error"
83	}
84	},
85	"503": {
86	"description": "Under maintenance",
87	"schema": {
88	"$ref": "../definitions.json#/error"
89	}
90	}
91	},
92	"x-koha-authorization": {
93	"permissions": {
94	"catalogue": "1"
95	}
96	}
97	},
98	"post": {
99	"x-mojo-to": "Quotes#add",
100	"operationId": "addQuote",
101	"tags": [
102	"quotes"
103	],
104	"parameters": [
105	{
106	"name": "body",
107	"in": "body",
108	"description": "A JSON object containing informations about the new quote",
109	"required": true,
110	"schema": {
111	"$ref": "../definitions.json#/quote"
112	}
113	}
114	],
115	"produces": [
116	"application/json"
117	],
118	"responses": {
119	"201": {
120	"description": "Quote added",
121	"schema": {
122	"$ref": "../definitions.json#/quote"
123	}
124	},
125	"401": {
126	"description": "Authentication required",
127	"schema": {
128	"$ref": "../definitions.json#/error"
129	}
130	},
131	"403": {
132	"description": "Access forbidden",
133	"schema": {
134	"$ref": "../definitions.json#/error"
135	}
136	},
137	"500": {
138	"description": "Internal error",
139	"schema": {
140	"$ref": "../definitions.json#/error"
141	}
142	},
143	"503": {
144	"description": "Under maintenance",
145	"schema": {
146	"$ref": "../definitions.json#/error"
147	}
148	}
149	},
150	"x-koha-authorization": {
151	"permissions": {
152	"tools": "edit_quotes"
153	}
154	}
155	}
156	},
157	"/quotes/{quote_id}": {
158	"get": {
159	"x-mojo-to": "Quotes#get",
160	"operationId": "getQuote",
161	"tags": [
162	"quotes"
163	],
164	"parameters": [
165	{
166	"$ref": "../parameters.json#/quote_id_pp"
167	}
168	],
169	"produces": [
170	"application/json"
171	],
172	"responses": {
173	"200": {
174	"description": "A Quote",
175	"schema": {
176	"$ref": "../definitions.json#/quote"
177	}
178	},
179	"404": {
180	"description": "Quote not found",
181	"schema": {
182	"$ref": "../definitions.json#/error"
183	}
184	},
185	"500": {
186	"description": "Internal error",
187	"schema": {
188	"$ref": "../definitions.json#/error"
189	}
190	},
191	"503": {
192	"description": "Under maintenance",
193	"schema": {
194	"$ref": "../definitions.json#/error"
195	}
196	}
197	},
198	"x-koha-authorization": {
199	"permissions": {
200	"catalogue": "1"
201	}
202	}
203	},
204	"put": {
205	"x-mojo-to": "Quotes#update",
206	"operationId": "updateQuote",
207	"tags": [
208	"quotes"
209	],
210	"parameters": [
211	{
212	"$ref": "../parameters.json#/quote_id_pp"
213	},
214	{
215	"name": "body",
216	"in": "body",
217	"description": "a quote object",
218	"required": true,
219	"schema": {
220	"$ref": "../definitions.json#/quote"
221	}
222	}
223	],
224	"produces": [
225	"application/json"
226	],
227	"responses": {
228	"200": {
229	"description": "A quote",
230	"schema": {
231	"$ref": "../definitions.json#/quote"
232	}
233	},
234	"401": {
235	"description": "Authentication required",
236	"schema": {
237	"$ref": "../definitions.json#/error"
238	}
239	},
240	"403": {
241	"description": "Access forbidden",
242	"schema": {
243	"$ref": "../definitions.json#/error"
244	}
245	},
246	"404": {
247	"description": "Quote not found",
248	"schema": {
249	"$ref": "../definitions.json#/error"
250	}
251	},
252	"500": {
253	"description": "Internal error",
254	"schema": {
255	"$ref": "../definitions.json#/error"
256	}
257	},
258	"503": {
259	"description": "Under maintenance",
260	"schema": {
261	"$ref": "../definitions.json#/error"
262	}
263	}
264	},
265	"x-koha-authorization": {
266	"permissions": {
267	"tools": "edit_quotes"
268	}
269	}
270	},
271	"delete": {
272	"x-mojo-to": "Quotes#delete",
273	"operationId": "deleteQuote",
274	"tags": [
275	"quotes"
276	],
277	"parameters": [
278	{
279	"$ref": "../parameters.json#/quote_id_pp"
280	}
281	],
282	"produces": [
283	"application/json"
284	],
285	"responses": {
286	"204": {
287	"description": "Quote deleted"
288	},
289	"401": {
290	"description": "Authentication required",
291	"schema": {
292	"$ref": "../definitions.json#/error"
293	}
294	},
295	"403": {
296	"description": "Access forbidden",
297	"schema": {
298	"$ref": "../definitions.json#/error"
299	}
300	},
301	"404": {
302	"description": "Quote not found",
303	"schema": {
304	"$ref": "../definitions.json#/error"
305	}
306	},
307	"500": {
308	"description": "Internal error",
309	"schema": {
310	"$ref": "../definitions.json#/error"
311	}
312	},
313	"503": {
314	"description": "Under maintenance",
315	"schema": {
316	"$ref": "../definitions.json#/error"
317	}
318	}
319	},
320	"x-koha-authorization": {
321	"permissions": {
322	"tools": "edit_quotes"
323	}
324	}
325	}
326	}
327	}

Lines 1-379 Link Here

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/quotes-upload.tt (-379 lines)
1	[% USE raw %]
2	[% USE Asset %]
3	[% SET footerjs = 1 %]
4	[% INCLUDE 'doc-head-open.inc' %]
5	<title>Koha &rsaquo; Tools &rsaquo; Quote uploader</title>
6	[% INCLUDE 'doc-head-close.inc' %]
7	[% Asset.css("css/uploader.css") \| $raw %]
8	[% Asset.css("css/quotes.css") \| $raw %]
9	</head>
10
11	<body id="tools_quotes" class="tools">
12	[% INCLUDE 'header.inc' %]
13	[% INCLUDE 'cat-search.inc' %]
14
15	<div id="breadcrumbs"><a href="/cgi-bin/koha/mainpage.pl">Home</a> &rsaquo; <a href="/cgi-bin/koha/tools/tools-home.pl">Tools</a> &rsaquo; <a href="/cgi-bin/koha/tools/quotes.pl">Quote editor</a> &rsaquo; Quote uploader</div>
16
17	<div class="main container-fluid">
18	<div class="row">
19	<div class="col-sm-10 col-sm-push-2">
20	<main>
21
22	[% INCLUDE 'quotes-upload-toolbar.inc' %]
23	<h2>Quote uploader</h2>
24	<div id="instructions">
25	<fieldset id="file_uploader_help" class="rows">
26	<legend>Instructions</legend>
27	<div id="file_uploader_inst">
28	<ul>
29	<li>The quote uploader accepts standard csv files with two columns: "source","text"</li>
30	<li>Click the "Choose File" button and select the csv file to be uploaded.</li>
31	<li>The file will be imported into an editable table for review prior to saving.</li>
32	</ul>
33	</div>
34	<div id="file_editor_inst">
35	<ul>
36	<li>Click on any field to edit the contents; Press the <Enter> key to save edit.</li>
37	<li>Click on one or more quote numbers to select entire quotes for deletion; Click the 'Delete Quote(s)' button to delete selected quotes.</li>
38	<li>Click the 'Save Quotes' button in the toolbar to save the entire batch of quotes.</li>
39	</ul>
40	</div>
41	</fieldset>
42	</div>
43	<fieldset id="file_uploader" class="rows">
44	<legend>Upload quotes</legend>
45	<div id="file_upload">
46	<input type="file" name="file" />
47	<button id="cancel_upload" style="display:none">Cancel upload</button>
48	<div id="progress_bar"><div class="percent">0%</div></div>
49	</div>
50	</fieldset>
51	<table id="quotes_editor" style="visibility: hidden;">
52	<thead>
53	<tr>
54	<th>Source</th>
55	<th>Text</th>
56	<th>Actions</th>
57	</tr>
58	</thead>
59	<tbody>
60	<!-- tbody content is generated by DataTables -->
61	<tr>
62	<td></td>
63	<td>Loading data...</td>
64	<td></td>
65	</tr>
66	</tbody>
67	</table>
68	<fieldset id="footer" class="action" style="visibility: hidden;">
69	</fieldset>
70
71	</main>
72	</div> <!-- /.col-sm-10.col-sm-push-2 -->
73
74	<div class="col-sm-2 col-sm-pull-10">
75	<aside>
76	[% INCLUDE 'tools-menu.inc' %]
77	</aside>
78	</div> <!-- /.col-sm-2.col-sm-pull-10 -->
79	</div> <!-- /.row -->
80
81	[% MACRO jsinclude BLOCK %]
82	[% Asset.js("js/tools-menu.js") \| $raw %]
83	[% INCLUDE 'datatables.inc' %]
84	[% Asset.js("lib/jquery/plugins/jquery.jeditable.mini.js") \| $raw %]
85	<script>
86	var oTable; //DataTable object
87	$(document).ready(function() {
88
89	$("#cancel_upload").on("click",function(e){
90	e.preventDefault();
91	fnAbortRead();
92	});
93	$("#cancel_quotes").on("click",function(){
94	return confirm( _("Are you sure you want to cancel this import?") );
95	});
96
97	// Credits:
98	// FileReader() code copied and hacked from:
99	// http://www.html5rocks.com/en/tutorials/file/dndfiles/
100	// fnCSVToArray() gratefully borrowed from:
101	// http://www.bennadel.com/blog/1504-Ask-Ben-Parsing-CSV-Strings-With-Javascript-Exec-Regular-Expression-Command.htm
102
103	var reader;
104	var progress = document.querySelector('.percent');
105	$("#server_response").hide();
106
107	function yuiGetData() {
108	fnGetData(document.getElementById('quotes_editor'));
109	}
110
111	function fnAbortRead() {
112	reader.abort();
113	}
114
115	function fnErrorHandler(evt) {
116	switch(evt.target.error.code) {
117	case evt.target.error.NOT_FOUND_ERR:
118	alert(_("File Not Found!"));
119	break;
120	case evt.target.error.NOT_READABLE_ERR:
121	alert(_("File is not readable"));
122	break;
123	case evt.target.error.ABORT_ERR:
124	break; // noop
125	default:
126	alert(_("An error occurred reading this file."));
127	};
128	}
129
130	function fnUpdateProgress(evt) {
131	// evt is an ProgressEvent.
132	if (evt.lengthComputable) {
133	var percentLoaded = Math.round((evt.loaded / evt.total) * 100);
134	// Increase the progress bar length.
135	if (percentLoaded < 100) {
136	progress.style.width = percentLoaded + '%';
137	progress.textContent = percentLoaded + '%';
138	}
139	}
140	}
141
142	function fnCSVToArray( strData, strDelimiter ){
143	// This will parse a delimited string into an array of
144	// arrays. The default delimiter is the comma, but this
145	// can be overriden in the second argument.
146
147	// Check to see if the delimiter is defined. If not,
148	// then default to comma.
149	strDelimiter = (strDelimiter \|\| ",");
150
151	// Create a regular expression to parse the CSV values.
152	var objPattern = new RegExp(
153	(
154	// Delimiters.
155	"(\\" + strDelimiter + "\|\\r?\\n\|\\r\|^)" +
156	// Quoted fields.
157	"(?:\"([^\"](?:\"\"[^\"])*)\"\|" +
158	// Standard fields.
159	"([^\"\\" + strDelimiter + "\\r\\n]*))"
160	),
161	"gi"
162	);
163
164	// Create an array to hold our data. Give the array
165	// a default empty first row.
166	var arrData = [[]];
167
168	// Create an array to hold our individual pattern
169	// matching groups.
170	var arrMatches = null;
171
172	// Keep looping over the regular expression matches
173	// until we can no longer find a match.
174	while (arrMatches = objPattern.exec( strData )){
175
176	// Get the delimiter that was found.
177	var strMatchedDelimiter = arrMatches[ 1 ];
178
179	// Check to see if the given delimiter has a length
180	// (is not the start of string) and if it matches
181	// field delimiter. If it does not, then we know
182	// that this delimiter is a row delimiter.
183	if ( strMatchedDelimiter.length && (strMatchedDelimiter != strDelimiter) ){
184	// Since we have reached a new row of data,
185	// add an empty row to our data array.
186	// Note: if there is not more data, we will have to remove this row later
187	arrData.push( [] );
188	}
189
190	// Now that we have our delimiter out of the way,
191	// let's check to see which kind of value we
192	// captured (quoted or unquoted).
193	if (arrMatches[ 2 ]){
194	// We found a quoted value. When we capture
195	// this value, unescape any double quotes.
196	var strMatchedValue = arrMatches[ 2 ].replace(
197	new RegExp( "\"\"", "g" ),
198	"\""
199	);
200	} else if (arrMatches[3]){
201	// We found a non-quoted value.
202	var strMatchedValue = arrMatches[ 3 ];
203	} else {
204	// There is no more valid data so remove the row we added earlier
205	// Is there a better way? Perhaps a look-ahead regexp?
206	arrData.splice(arrData.length-1, 1);
207	}
208
209	// Now that we have our value string, let's add
210	// it to the data array.
211	arrData[ arrData.length - 1 ].push( strMatchedValue );
212	}
213
214	// Return the parsed data.
215	return( arrData );
216	}
217
218	function fnDataTable(aaData) {
219	for(var i=0; i<aaData.length; i++) {
220	aaData[i].unshift(i+1); // Add a column w/quote number
221	}
222
223	/* Transition from the quote file uploader to the quote file editor interface */
224	$('#toolbar').css("visibility","visible");
225	$('#toolbar').css("position","");
226	$('#file_editor_inst').css("visibility", "visible");
227	$('#file_editor_inst').css("position", "");
228	$('#file_uploader_inst').css("visibility", "hidden");
229	$('#save_quotes').css("visibility","visible");
230	$('#file_uploader').css("visibility","hidden");
231	$('#file_uploader').css("position","absolute");
232	$('#file_uploader').css("top","-150px");
233	$('#quotes_editor').css("visibility","visible");
234	$("#save_quotes").on("click", yuiGetData);
235	$("#delete_quote").on("click", fnClickDeleteRow);
236
237	oTable = $('#quotes_editor').dataTable( {
238	"bAutoWidth" : false,
239	"bPaginate" : true,
240	"bSort" : false,
241	"sPaginationType" : "full_numbers",
242	"sDom": '<"top pager"iflp>rt<"bottom pager"flp><"clear">',
243	"aaData" : aaData,
244	"aoColumns" : [
245	{
246	"sTitle" : _("Number"),
247	"sWidth" : "2%",
248	},
249	{
250	"sTitle" : _("Source"),
251	"sWidth" : "15%",
252	},
253	{
254	"sTitle" : _("Quote"),
255	"sWidth" : "83%",
256	},
257	],
258	"fnPreDrawCallback": function(oSettings) {
259	return true;
260	},
261	"fnRowCallback": function( nRow, aData, iDisplayIndex ) {
262	/* do foo on various cells in the current row */
263	var quoteNum = $('td', nRow)[0].innerHTML;
264	$(nRow).attr("id", quoteNum); /* set row ids to quote number */
265	$('td:eq(0)', nRow).click(function() {$(this.parentNode).toggleClass('selected',this.clicked);}); /* add row selectors */
266	$('td:eq(0)', nRow).attr("title", _("Click ID to select/deselect quote"));
267	/* apply no_edit id to noEditFields */
268	noEditFields = [0]; /* number */
269	for (i=0; i<noEditFields.length; i++) {
270	$('td', nRow)[noEditFields[i]].setAttribute("id","no_edit");
271	}
272	return nRow;
273	},
274	"fnDrawCallback": function(oSettings) {
275	/* Apply the jEditable handlers to the table on all fields w/o the no_edit id */
276	$('#quotes_editor tbody td[id!="no_edit"]').editable( function(value, settings) {
277	var cellPosition = oTable.fnGetPosition( this );
278	oTable.fnUpdate(value, cellPosition[0], cellPosition[1], false, false);
279	return(value);
280	},
281	{
282	"callback" : function( sValue, y ) {
283	oTable.fnDraw(false); /* no filter/sort or we lose our pagination */
284	},
285	"height" : "14px",
286	});
287	},
288	});
289	$('#footer').css("visibility","visible");
290	}
291
292	function fnHandleFileSelect(evt) {
293	// Reset progress indicator on new file selection.
294	progress.style.width = '0%';
295	progress.textContent = '0%';
296
297	reader = new FileReader();
298	reader.onerror = fnErrorHandler;
299	reader.onprogress = fnUpdateProgress;
300	reader.onabort = function(e) {
301	alert(_("File read cancelled"));
302	parent.location='quotes-upload.pl';
303	};
304	reader.onloadstart = function(e) {
305	$('#cancel_upload').show();
306	$('#progress_bar').addClass("loading");
307	};
308	reader.onload = function(e) {
309	// Ensure that the progress bar displays 100% at the end.
310	progress.style.width = '100%';
311	progress.textContent = '100%';
312	$('#cancel_upload').hide();
313	quotes = fnCSVToArray(e.target.result, ',');
314	fnDataTable(quotes);
315	}
316
317	// perform various sanity checks on the target file prior to uploading...
318	var fileType = evt.target.files[0].type \|\| 'unknown';
319	var fileSizeInK = Math.round(evt.target.files[0].size/1024);
320
321	if (!fileType.match(/comma-separated-values\|csv\|excel\|calc/i)) {
322	alert(_("Uploads limited to csv. Incorrect filetype: %s").format(fileType));
323	parent.location='quotes-upload.pl';
324	return;
325	}
326	if (fileSizeInK > 512) {
327	if (!confirm(_("%s %s KB Do you really want to upload this file?").format(evt.target.files[0].name, fileSizeInK))) {
328	parent.location='quotes-upload.pl';
329	return;
330	}
331	}
332	// Read in the image file as a text string.
333	reader.readAsText(evt.target.files[0]);
334	}
335
336	$('#file_upload').one('change', fnHandleFileSelect);
337
338	});
339
340	function fnGetData(element) {
341	var jqXHR = $.ajax({
342	url : "/cgi-bin/koha/tools/quotes/quotes-upload_ajax.pl",
343	type : "POST",
344	contentType : "application/x-www-form-urlencoded", // we must claim this mimetype or CGI will not decode the URL encoding
345	dataType : "json",
346	data : {
347	"quote" : encodeURI ( JSON.stringify(oTable.fnGetData()) ),
348	"action" : "add",
349	},
350	success : function(){
351	var response = JSON.parse(jqXHR.responseText);
352	if (response.success) {
353	alert(_("%s quotes saved.").format(response.records));
354	window.location.reload(true); // is this the best route?
355	} else {
356	alert(_("%s quotes saved, but an error has occurred. Please ask your administrator to check the server log for more details.").format(response.records));
357	window.location.reload(true); // is this the best route?
358	}
359	},
360	});
361	}
362
363	function fnClickDeleteRow() {
364	var idsToDelete = oTable.$('.selected').map(function() {
365	return this.id;
366	}).get().join(', ');
367	if (!idsToDelete) {
368	alert(_("Please select a quote(s) by clicking the quote id(s) you desire to delete."));
369	}
370	else if (confirm(_("Are you sure you wish to delete quote(s) %s?").format(idsToDelete))) {
371	oTable.$('.selected').each(function(){
372	oTable.fnDeleteRow(this);
373	});
374	}
375	}
376	</script>
377	[% END %]
378
379	[% INCLUDE 'intranet-bottom.inc' %]

Lines 1-42 Link Here

(-)a/tools/quotes-upload.pl (-42 lines)
1	#!/usr/bin/perl
2
3	# Copyright 2012 Foundations Bible College Inc.
4	#
5	# This file is part of Koha.
6	#
7	# Koha is free software; you can redistribute it and/or modify it
8	# under the terms of the GNU General Public License as published by
9	# the Free Software Foundation; either version 3 of the License, or
10	# (at your option) any later version.
11	#
12	# Koha is distributed in the hope that it will be useful, but
13	# WITHOUT ANY WARRANTY; without even the implied warranty of
14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15	# GNU General Public License for more details.
16	#
17	# You should have received a copy of the GNU General Public License
18	# along with Koha; if not, see <http://www.gnu.org/licenses>.
19
20	use Modern::Perl;
21
22	use CGI qw ( -utf8 );
23	use autouse 'Data::Dumper' => qw(Dumper);
24
25	use C4::Auth;
26	use C4::Koha;
27	use C4::Context;
28	use C4::Output;
29
30	my $cgi = CGI->new;
31
32	my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
33	{
34	template_name => "tools/quotes-upload.tt",
35	query => $cgi,
36	type => "intranet",
37	flagsrequired => { tools => 'edit_quotes' },
38	debug => 1,
39	}
40	);
41
42	output_html_with_http_headers $cgi, $cookie, $template->output;

Lines 1-7 Link Here

(-)a/tools/quotes.pl (-11 / +66 lines)
1	#!/usr/bin/perl	1	#!/usr/bin/perl
2		2
3	# Copyright 2012 Foundations Bible College Inc.
4	#
5	# This file is part of Koha.	3	# This file is part of Koha.
6	#	4	#
7	# Koha is free software; you can redistribute it and/or modify it	5	# Koha is free software; you can redistribute it and/or modify it
Lines 20-42 Link Here
20	use Modern::Perl;	18	use Modern::Perl;
21		19
22	use CGI qw ( -utf8 );	20	use CGI qw ( -utf8 );
23	use autouse 'Data::Dumper' => qw(Dumper);	21	use Try::Tiny;
24		22
25	use C4::Auth;	23	use C4::Auth;
26	use C4::Koha;
27	use C4::Context;	24	use C4::Context;
28	use C4::Output;	25	use C4::Output;
		26	use Koha::Quotes;
29		27
30	my $cgi = CGI->new;	28	my $input = CGI->new;
31		29
32	my ( $template, $borrowernumber, $cookie ) = get_template_and_user(	30	my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
33	{	31	{
34	template_name => "tools/quotes.tt",	32	template_name => "tools/quotes.tt",
35	query => $cgi,	33	query => $input,
36	type => "intranet",	34	type => "intranet",
37	flagsrequired => { tools => 'edit_quotes' },	35	flagsrequired => { tools => 'edit_quotes' },
38	debug => 1,	36	debug => 1,
39	}	37	}
40	);	38	);
41		39
42	output_html_with_http_headers $cgi, $cookie, $template->output;	40	my $id = $input->param('id');
		41	my $op = $input->param('op') \|\| 'list';
		42	my @messages;
		43
		44	if ( $op eq 'add_form' ) {
		45	$template->param( quote => Koha::Quotes->find($id), );
		46	}
		47	elsif ( $op eq 'add_validate' ) {
		48	my @fields = qw(
		49	source
		50	text
		51	);
		52
		53	if ($id) {
		54	my $quote = Koha::Quotes->find($id);
		55	for my $field (@fields) {
		56	$quote->$field( scalar $input->param($field) );
		57	}
		58
		59	try {
		60	$quote->store;
		61	push @messages, { type => 'message', code => 'success_on_update' };
		62	}
		63	catch {
		64	push @messages, { type => 'alert', code => 'error_on_update' };
		65	}
		66	}
		67	else {
		68	my $quote = Koha::Quote->new(
		69	{
		70	id => $id,
		71	( map { $_ => scalar $input->param($_) \|\| undef } @fields )
		72	}
		73	);
		74
		75	try {
		76	$quote->store;
		77	push @messages, { type => 'message', code => 'success_on_insert' };
		78	}
		79	catch {
		80	push @messages, { type => 'alert', code => 'error_on_insert' };
		81	};
		82	}
		83	$op = 'list';
		84	}
		85	else {
		86	$op = 'list';
		87	}
		88
		89	$template->param( quotes_count => Koha::Quotes->search->count )
		90	if $op eq 'list';
		91
		92	$template->param(
		93	messages => \@messages,
		94	op => $op,
		95	);
		96
		97	output_html_with_http_headers $input, $cookie, $template->output;

Lines 1-65 Link Here

(-)a/tools/quotes/quotes-upload_ajax.pl (-65 lines)
1	#!/usr/bin/perl
2
3	# Copyright 2012 Foundations Bible College Inc.
4	#
5	# This file is part of Koha.
6	#
7	# Koha is free software; you can redistribute it and/or modify it
8	# under the terms of the GNU General Public License as published by
9	# the Free Software Foundation; either version 3 of the License, or
10	# (at your option) any later version.
11	#
12	# Koha is distributed in the hope that it will be useful, but
13	# WITHOUT ANY WARRANTY; without even the implied warranty of
14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15	# GNU General Public License for more details.
16	#
17	# You should have received a copy of the GNU General Public License
18	# along with Koha; if not, see <http://www.gnu.org/licenses>.
19
20	use Modern::Perl;
21
22	use CGI qw ( -utf8 );
23	use JSON;
24	use URI::Escape;
25	use autouse 'Data::Dumper' => qw(Dumper);
26
27	use C4::Auth;
28	use C4::Koha;
29	use C4::Context;
30	use C4::Output;
31
32	my $cgi = CGI->new;
33	my $dbh = C4::Context->dbh;
34
35	my ( $status, $cookie, $sessionID ) = C4::Auth::check_api_auth( $cgi, { tools => 'edit_quotes' } );
36	unless ($status eq "ok") {
37	print $cgi->header(-type => 'application/json', -status => '403 Forbidden');
38	print to_json({ auth_status => $status });
39	exit 0;
40	}
41
42	my $success = 'true';
43	my $quotes_tmp = uri_unescape( $cgi->param('quote' ) );
44	my $quotes = decode_json( $quotes_tmp );
45
46	my $action = $cgi->param('action');
47
48	my $sth = $dbh->prepare('INSERT INTO quotes (source, text) VALUES (?, ?);');
49
50	my $insert_count = 0;
51
52	foreach my $quote (@$quotes) {
53	$insert_count++ if $sth->execute($quote->[1], $quote->[2]);
54	if ($sth->err) {
55	warn sprintf('Database returned the following error: %s', $sth->errstr);
56	$success = 'false';
57	}
58	}
59
60	print $cgi->header('application/json');
61
62	print to_json({
63	success => $success,
64	records => $insert_count,
65	});

Lines 1-109 Link Here

(-)a/tools/quotes/quotes_ajax.pl (-110 lines)
1	#!/usr/bin/perl
2
3	# Copyright 2012 Foundations Bible College Inc.
4	#
5	# This file is part of Koha.
6	#
7	# Koha is free software; you can redistribute it and/or modify it
8	# under the terms of the GNU General Public License as published by
9	# the Free Software Foundation; either version 3 of the License, or
10	# (at your option) any later version.
11	#
12	# Koha is distributed in the hope that it will be useful, but
13	# WITHOUT ANY WARRANTY; without even the implied warranty of
14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15	# GNU General Public License for more details.
16	#
17	# You should have received a copy of the GNU General Public License
18	# along with Koha; if not, see <http://www.gnu.org/licenses>.
19
20	use Modern::Perl;
21
22	use CGI qw ( -utf8 );
23	use JSON;
24	use autouse 'Data::Dumper' => qw(Dumper);
25
26	use C4::Auth;
27	use C4::Context;
28
29	my $cgi = CGI->new;
30	my $dbh = C4::Context->dbh;
31	my $sort_columns = ["id", "source", "text", "timestamp"];
32
33	my ( $status, $cookie, $sessionID ) = C4::Auth::check_api_auth( $cgi, { tools => 'edit_quotes' } );
34	unless ($status eq "ok") {
35	print $cgi->header(-type => 'application/json', -status => '403 Forbidden');
36	print to_json({ auth_status => $status });
37	exit 0;
38	}
39
40	# NOTE: This is a collection of ajax functions for use with tools/quotes.pl
41
42	my $params = $cgi->Vars; # NOTE: Multivalue parameters NOT allowed!!
43
44	print $cgi->header('application/json; charset=utf-8');
45
46	my $action = $params->{'action'} \|\| 'get';
47	if ($action eq 'add') {
48	my $sth = $dbh->prepare('INSERT INTO quotes (source, text) VALUES (?, ?);');
49	$sth->execute($params->{'source'}, $params->{'text'});
50	if ($sth->err) {
51	warn sprintf('Database returned the following error: %s', $sth->errstr);
52	exit 0;
53	}
54	my $new_quote_id = $dbh->{q{mysql_insertid}}; # ALERT: mysqlism here
55	$sth = $dbh->prepare('SELECT * FROM quotes WHERE id = ?;');
56	$sth->execute($new_quote_id);
57	print to_json($sth->fetchall_arrayref, {utf8 =>1});
58	exit 0;
59	}
60	elsif ($action eq 'edit') {
61	my $aaData = [];
62	my $editable_columns = [qw(source text)]; # pay attention to element order; these columns match the quotes table columns
63	my $sth = $dbh->prepare("UPDATE quotes SET $editable_columns->[$params->{'column'}-1] = ? WHERE id = ?;");
64	$sth->execute($params->{'value'}, $params->{'id'});
65	if ($sth->err) {
66	warn sprintf('Database returned the following error: %s', $sth->errstr);
67	exit 1;
68	}
69	$sth = $dbh->prepare("SELECT $editable_columns->[$params->{'column'}-1] FROM quotes WHERE id = ?;");
70	$sth->execute($params->{'id'});
71	$aaData = $sth->fetchrow_array();
72	print Encode::encode('utf8', $aaData);
73
74	exit 0;
75	}
76	elsif ($action eq 'delete') {
77	my $sth = $dbh->prepare("DELETE FROM quotes WHERE id = ?;");
78	$sth->execute($params->{'id'});
79	if ($sth->err) {
80	warn sprintf('Database returned the following error: %s', $sth->errstr);
81	exit 1;
82	}
83	exit 0;
84	}
85	else {
86	my $aaData = [];
87	my $iTotalRecords = '';
88	my $sth = '';
89
90	$iTotalRecords = $dbh->selectrow_array('SELECT count(*) FROM quotes;');
91	$sth = $dbh->prepare("SELECT * FROM quotes;");
92
93	$sth->execute();
94	if ($sth->err) {
95	warn sprintf('Database returned the following error: %s', $sth->errstr);
96	exit 1;
97	}
98
99	$aaData = $sth->fetchall_arrayref;
100	my $iTotalDisplayRecords = $iTotalRecords; # no filtering happening here
101
102
103	print to_json({
104	iTotalRecords => $iTotalRecords,
105	iTotalDisplayRecords=> $iTotalDisplayRecords,
106	sEcho => $params->{'sEcho'},
107	aaData => $aaData,
108	}, {utf8 =>1});
109	}
110	-