Attachment #42693 for bug #14843

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




    return $dbh->last_insert_id(undef,undef,'message_queue', undef);
}

=head2 DequeueLetter

  my $success = DequeueLetter( { message_id => $message_id } )

Removes a message from message_queue

return 1 on success, otherwise 0

=cut

sub DequeueLetter {
    my $params = shift or return;

    return unless exists $params->{'message_id'} or not $params->{'message_id'};

    my $dbh       = C4::Context->dbh();
    my $statement = << 'ENDSQL';
DELETE FROM message_queue
WHERE message_id = ?
ENDSQL

    my $sth    = $dbh->prepare($statement);
    my $result = $sth->execute(
        $params->{'message_id'},              # message_id
    );
    return ($result > 0);
}

=head2 SendQueuedMessages ([$hashref]) 

  my $sent = SendQueuedMessages( { verbose => 1 } );


    my $dbh = C4::Context->dbh();
    my $statement = << 'ENDSQL';
SELECT message_id, borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, to_address, from_address, content_type, delivery_note
FROM message_queue
ENDSQL


    return $sth->fetchall_arrayref({});
}


=head2 UpdateQueuedMessage ([$hashref])

  my $message = UpdateQueuedMessage( {
        borrowernumber => '123', message_id => '100',
        letter => { subject => "New subject", content => "New content" },
    } );

Updates the message in message_queue. Message is identified by
required parameter message_id.

returns:
1 on success, otherwise 0

=cut

sub UpdateQueuedMessage {
    my $params = shift;

    if (not $params->{'message_id'}) {
        warn __PACKAGE__."::UpdateQueuedMessage: param message_id is required";
        return;
    }
    
    my $dbh = C4::Context->dbh();
    my $statement = << 'ENDSQL';
UPDATE message_queue
SET
ENDSQL

    my @query_params;
    
    if ($params->{'borrowernumber'}) {
         $statement .= " borrowernumber = ?, ";
         push @query_params, $params->{'borrowernumber'};
    }
    if ($params->{'subject'}) {
         $statement .= " subject = ?, ";
         push @query_params, $params->{'subject'};
    }
    if ($params->{'content'}) {
         $statement .= " content = ?, ";
         push @query_params, $params->{'content'};
    }
    if ($params->{'metadata'}) {
         $statement .= " metadata = ?, ";
         push @query_params, $params->{'metadata'};
    }
    if ($params->{'letter_code'}) {
         $statement .= " letter_code = ?, ";
         push @query_params, $params->{'letter_code'};
    }
    if ($params->{'content_type'}) {
         $statement .= " content_type = ?, ";
         push @query_params, $params->{'content_type'};
    }
    if ($params->{'message_transport_type'}) {
         $statement .= " message_transport_type = ?, ";
         push @query_params, $params->{'message_transport_type'};
    }
    if ($params->{'status'}) {
         $statement .= " status = ?, ";
         push @query_params, $params->{'status'};
    }
    if ($params->{'to_address'}) {
         $statement .= " to_address = ?, ";
         push @query_params, $params->{'to_address'};
    }
    if ($params->{'from_address'}) {
         $statement .= " from_address = ?, ";
         push @query_params, $params->{'from_address'};
    }
    if ($params->{'delivery_note'}) {
         $statement .= " delivery_note = ?, ";
         push @query_params, $params->{'delivery_note'};
    }
    return 0 if $statement =~ /SET(\s*)$/;
    $statement =~ s/,(\s*)$//g; # remove last ,
    
    $statement .= " WHERE message_id = ?";
    push @query_params, $params->{'message_id'};

    my $sth = $dbh->prepare( $statement );
    my $result = $sth->execute( @query_params );
    return ($result > 0);
}


=head2 GetMessageTransportTypes

  my @mtt = GetMessageTransportTypes();




package Koha::REST::V1::Messages;

use Modern::Perl;

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

use C4::Letters;
use Data::Dumper;
use C4::Log;


=head2 list_messages($c, $args, $cb)

Lists all messages from message_queue.

=cut
sub list_messages {
    my ($c, $args, $cb) = @_;

    my $messages = C4::Letters::GetQueuedMessages();

    if (@$messages > 0) {
        my $return_messages;
        foreach my $message (@$messages){
            push @$return_messages, _set_default_values({ message => $message });
        }
        return $c->$cb($return_messages , 200);
    }
    $c->$cb({ error => "No messages found." }, 404);
}



=head2 create_message($c, $args, $cb)

Creates a new message into message queue.

=cut
sub create_message {
    my ($c, $args, $cb) = @_;

    # Content is required. Check for missing content.
    if (exists $args->{body}->{content}) {
        my $content = $args->{body}->{content};
        $content =~ s/\s+//g if(defined $content);
        if ( not $content ) {
            return $c->$cb({ error => "Property cannot be empty in: /body/content" }, 400);
        }
    } else {
        return $c->$cb({ error => "Missing property: /body/content" }, 400);
    }
    
    if (exists $args->{body}->{borrowernumber}) {
        my $content = $args->{body}->{borrowernumber};
        $content =~ s/\s+//g if(defined $content);
        if ( not $content ) {
            return $c->$cb({ error => "Property cannot be empty in: /body/borrowernumber" }, 400);
        }
    } else {
        return $c->$cb({ error => "Missing property: /body/borrowernumber" }, 400);
    }
    
    
    # message_transport_type is required. Check for missing parameter.
    my $transport_type = $args->{body}->{message_transport_type};
    $transport_type =~ s/\s+//g if(defined $transport_type);
    if ( not $transport_type ) {
        return $c->$cb({ error => "Missing property: /body/message_transport_type" }, 400);
    }
    
    # message_transport_type also must be one of the predefined values
    my $transport_types = C4::Letters::GetMessageTransportTypes();
    if ( !grep( /^$transport_type$/, @$transport_types ) ) {
        return $c->$cb({ error => "Invalid value '".$transport_type."' in: /body/message_transport_type. Valid values are ". join(', ', @$transport_types) }, 400);
    }
    
    # Make some changes in names of parameters due to inconsistent naming in C4::Letters
    
    # Enqueue the letter
    my $message = C4::Letters::EnqueueLetter(_convert_to_enqueue({ message => $args->{'body'} }));
    
    # Check if the message was enqueued
    if ($message){
        # Get the newly created message and return it
        $message = C4::Letters::GetMessage( $message );
        
        $message = _set_default_values({ message => $message });
        
        &logaction(
        "NOTICES",
        "CREATE",
        $message->{message_id},
        ""
        );
        
        return $c->$cb($message, 201);
    }
    $c->$cb({ error => "Message could not be created." }, 404)
}



=head2 update_message($c, $args, $cb)

Updates the message in message_queue.

=cut
sub update_message {
    my ($c, $args, $cb) = @_;

    # Content is required. Check for missing content.
    if (exists $args->{body}->{content}) {
        my $content = $args->{body}->{content};
        $content =~ s/\s+//g if(defined $content);
        if ( $content eq '' ) {
            return $c->$cb({ error => "Property cannot be empty in: /body/content" }, 400);
        }
    }
    
    if (exists $args->{body}->{message_transport_type}) {
        my $transport_type = $args->{body}->{message_transport_type};
        # message_transport_type also must be one of the predefined values
        my $transport_types = C4::Letters::GetMessageTransportTypes();
        if ( !grep( /^$transport_type$/, @$transport_types ) ) {
            return $c->$cb({ error => "Invalid value '".$transport_type
                            ."' in: /body/message_transport_type. Valid values are "
                            . join(', ', @$transport_types) }, 400);
        }
    }

    # create update hash
    my $update = $args->{'body'};
    $update->{'message_id'} = $args->{'messagenumber'};
    
    my $message = C4::Letters::UpdateQueuedMessage( $update );
    return $c->$cb({ error => "Message could not be found." }, 404) if not $message;
    
    $message = C4::Letters::GetMessage($args->{'messagenumber'});
    
    if ($message){
        $message = _set_default_values({ message => $message });
        
        &logaction(
        "NOTICES",
        "UPDATE",
        $message->{message_id},
        ""
        );
        
        return $c->$cb($message, 200);
    }
    $c->$cb({ error => "Message could not be updated." }, 404);
}



=head2 delete_message($c, $args, $cb)

Delete the message from message_queue.

=cut
sub delete_message {
    my ($c, $args, $cb) = @_;

    my $message = C4::Letters::DequeueLetter({ message_id => $args->{'messagenumber'} });
    
    if ($message){
        
        &logaction(
        "NOTICES",
        "DELETE",
        $args->{'messagenumber'},
        ""
        );
        
        return $c->$cb('', 204);
    }
    
    $c->$cb({ error => "Message could not be found." }, 404)
}



=head2 get_message($c, $args, $cb)

Returns a message from message_queue.

=cut
sub get_message {
    my ($c, $args, $cb) = @_;

    my $message = C4::Letters::GetMessage($args->{'messagenumber'});

    if ($message) {
        my $message = _set_default_values({ message => $message });
        
        return $c->$cb($message, 200);
    }
    
    return $c->$cb({ error => "Could not find the message" }, 404);
}



=head2 create_resend($c, $args, $cb)

Attempts to resend a message.

=cut
sub create_resend {
    my ($c, $args, $cb) = @_;


    my $message = C4::Letters::GetMessage($args->{'messagenumber'});

    if ($message) {
        if (C4::Letters::ResendMessage($args->{'messagenumber'})) {

            &logaction(
            "NOTICES",
            "RESEND",
            $message->{message_id},
            ""
            );

            return $c->$cb('', 204);
        }
    }

    return $c->$cb({ error => "Could not find the message" }, 404);
}



=head2 _set_default_values({ message => $message })

=cut
sub _set_default_values {
    my $params = shift;
    
    return unless exists $params->{'message'} or not defined $params->{'message'};
    
    # Convert the returned message into C4::Letters::EnqueueLetter format
    return {
        message_id => int($params->{'message'}->{'message_id'}),
        borrowernumber => int($params->{'message'}->{'borrowernumber'}),
        subject => $params->{'message'}->{'subject'} || '',
        content => $params->{'message'}->{'content'} || '',
        letter_code => $params->{'message'}->{'letter_code'} || '',
        content_type => $params->{'message'}->{'content_type'} || '',
        metadata => $params->{'message'}->{'metadata'} || '',
        message_transport_type => $params->{'message'}->{'message_transport_type'} || '',
        to_address => $params->{'message'}->{'to_address'} || '',
        from_address => $params->{'message'}->{'from_address'} || '',
        delivery_note => $params->{'message'}->{'delivery_note'} || '',
        status => $params->{'message'}->{'status'} || '',
        time_queued => $params->{'message'}->{'time_queued'} || ''
    };
}



=head2 _convert_to_message({ message => $message })

Due to inconsistent naming in C4::Letters::EnqueueLetter, we use the
database format and convert it in this function into the format that
EnqueueLetter supports.

=cut
sub _convert_to_enqueue {
    my $params = shift;
    
    return unless exists $params->{'message'} or not defined $params->{'message'};
    
    # Convert the returned message into C4::Letters::EnqueueLetter format
    return {
        borrowernumber => int($params->{'message'}->{'borrowernumber'}),
        letter => {
            title => $params->{'message'}->{'subject'} || '',
            content => $params->{'message'}->{'content'} || '',
            code => $params->{'message'}->{'letter_code'} || '',
            'content-type' => $params->{'message'}->{'content_type'} || '',
            metadata => $params->{'message'}->{'metadata'} || '',
        },
        message_transport_type => $params->{'message'}->{'message_transport_type'} || '',
        to_address => $params->{'message'}->{'to_address'} || '',
        from_address => $params->{'message'}->{'from_address'} || '',
        delivery_note => $params->{'message'}->{'delivery_note'} || ''
    };
}

1;




          }
        }
      }
    },
    "/messages": {
      "get": {
        "x-mojo-controller": "Koha::REST::V1::Messages",
        "operationId": "listMessages",
        "x-koha-permission": {
          "messages": "get_message"
        },
        "tags": ["messages"],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A list of messages",
            "schema": {
              "type": "array",
              "items": {
                "$ref" : "#/definitions/message"
              }
            }
          },
          "404": {
            "description": "Messages not found",
            "schema": {
              "$ref": "#/definitions/error"
            }
          }
        }
      },
      "post": {
        "x-mojo-controller": "Koha::REST::V1::Messages",
        "operationId": "createMessage",
        "x-koha-permission": {
          "messages": "create_message"
        },
        "tags": ["messages"],
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "description": "A JSON object containing informations about the new message",
            "required": true,
            "schema": { "$ref": "#/definitions/message" }
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "201": {
            "description": "A message",
            "schema": {
                "$ref": "#/definitions/message"
            }
          },
          "400": {
            "description": "Missing or wrong parameters",
            "schema": { "$ref": "#/definitions/error" }
          }
        }
      }
    },
    "/messages/{messagenumber}": {
      "put": {
        "x-mojo-controller": "Koha::REST::V1::Messages",
        "operationId": "updateMessage",
        "x-koha-permission": {
          "messages": "update_message"
        },
        "tags": ["messages"],
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "description": "A JSON object containing informations about the new message",
            "required": false,
            "schema": { "$ref": "#/definitions/message" }
          },
          {
            "$ref": "#/parameters/messagenumberPathParam"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A message",
            "schema": {
              "$ref" : "#/definitions/message"
            }
          },
          "400": {
            "description": "Missing or wrong parameters",
            "schema": { "$ref": "#/definitions/error" }
          },
          "404": {
            "description": "Message not found",
            "schema": {
              "$ref": "#/definitions/error"
            }
          }
        }
      },
      "delete": {
        "x-mojo-controller": "Koha::REST::V1::Messages",
        "operationId": "deleteMessage",
        "x-koha-permission": {
          "messages": "delete_message"
        },
        "tags": ["messages"],
        "parameters": [
          {
            "$ref": "#/parameters/messagenumberPathParam"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "204": {
            "description": "Deleting the message succeeded.",
            "schema": {
              "type": "string"
            }
          },
          "404": {
            "description": "Message not found.",
            "schema": {
              "$ref": "#/definitions/error"
            }
          }
        }
      },
      "get": {
        "x-mojo-controller": "Koha::REST::V1::Messages",
        "operationId": "getMessage",
        "x-koha-permission": {
          "messages": "get_message"
        },
        "tags": ["messages"],
        "parameters": [
          {
            "$ref": "#/parameters/messagenumberPathParam"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "A message",
            "schema": {
              "$ref" : "#/definitions/message"
            }
          },
          "404": {
            "description": "Message not found",
            "schema": {
              "$ref": "#/definitions/error"
            }
          }
        }
      }
    },
    "/messages/{messagenumber}/resend": {
      "post": {
        "x-mojo-controller": "Koha::REST::V1::Messages",
        "operationId": "createResend",
        "description": "Resends a message.",
        "x-koha-permission": {
          "messages": "resend_message"
        },
        "tags": ["messages"],
        "parameters": [
          {
            "$ref": "#/parameters/messagenumberPathParam"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "204": {
            "description": "Resending the message succeeded.",
            "schema": {
              "type": "string"
            }
          },
          "404": {
            "description": "Message not found",
            "schema": {
              "$ref": "#/definitions/error"
            }
          }
        }
      }
    }
  },
  "definitions": {

    "borrowernumber": {
      "description": "Borrower internal identifier"
    },

    "branchcode": {
      "description": "Branch code"
    },
    "itemnumber": {
      "description": "Item internal identifier"
    },
    "message": {
      "type": "object",
      "properties": {
        "message_id": {
          "description": "Message internal identifier",
          "type": "integer"
        },
        "time_queued": {
          "description": "Date and time of when message was placed in queue",
          "type": "string"
        },
        "borrowernumber": {
          "$ref": "#/definitions/borrowernumber"
        },
        "subject": {
          "description": "Subject of the message",
          "type": "string"
        },
        "content": {
          "description": "Content of the message",
          "type": "string"
        },
        "metadata": {
          "description": "",
          "type": "string"
        },
        "letter_code": {
          "description": "",
          "type": "string"
        },
        "content_type": {
          "description": "Content type",
          "type": "string"
        },
        "message_transport_type": {
          "description": "Transport method. Values accepted by default are 'email', 'sms', 'phone' and 'print'",
          "type": "string"
        },
        "status": {
          "description": "Delivery status",
          "type": "string"
        },
        "to_address": {
          "description": "Destination email address",
          "type": "string"
        },
        "from_address": {
          "description": "Source address of email",
          "type": "string"
        },
        "delivery_note": {
          "description": "Additional delivery notes",
          "type": "string"
        }
      }
    },
    "error": {
      "type": "object",
      "properties": {

      "description": "Internal item identifier",
      "required": "true",
      "type": "integer"
    },
    "messagenumberPathParam": {
      "name": "messagenumber",
      "in": "path",
      "description": "Internal message identifier",
      "required": "true",
      "type": "integer"
    }
  },
  "securityDefinitions": {




#!/usr/bin/perl

# Copyright Open Source Freedom Fighters
#
# 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, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

use C4::Context;
use Koha::AtomicUpdater;

my $dbh = C4::Context->dbh();
my $atomicUpdater = Koha::AtomicUpdater->new();

unless($atomicUpdater->find('Bug14767-Add_Permissions_for_message_queue_REST_operations.pl')) {

    use Koha::Auth::PermissionManager;
    my $pm = Koha::Auth::PermissionManager->new();
    $pm->addPermissionModule({module => 'messages', description => 'Permission regarding notifications and messages in message queue.'});
    $pm->addPermission({module => 'messages', code => 'get_message', description => "Allows to get the messages in message queue."});
    $pm->addPermission({module => 'messages', code => 'create_message', description => "Allows to create a new message and queue it."});
    $pm->addPermission({module => 'messages', code => 'update_message', description => "Allows to update messages in message queue."});
    $pm->addPermission({module => 'messages', code => 'delete_message', description => "Allows to delete a message and queue it."});
    $pm->addPermission({module => 'messages', code => 'resend_message', description => "Allows to resend messages in message queue."});

    print "Upgrade done (Bug 14767: Add Pemissions for message queue REST operations)\n";
}




package t::db_dependent::Api::V1::Messages;

use Modern::Perl;
use Test::More;

use t::lib::TestObjects::ObjectFactory;
use t::lib::TestObjects::MessageQueueFactory;

use C4::Letters;

sub get200 {
    my ($class, $restTest, $driver) = @_;
    my $testContext = $restTest->get_testContext();
    my $activeUser = $restTest->get_activeBorrower();
    my $path = $restTest->get_routePath();
    
    #Create the test context.
    my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
                        {
                            subject => "The quick brown fox",
                            content => "Jumps over the lazy dog.",
                            cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
                            message_transport_type => 'sms',
                            from_address => '11A001@example.com',
                        }, undef, $testContext, undef, undef);

    my $messagenumber = $messages->{'11A001@example.com'}->{message_id};
    
    $driver->get_ok($path => {Accept => 'text/json'});
    $driver->status_is(200);

    $driver->json_has("message_id", "Message id in JSON.");

    return 1;
}

sub get404 {
    my ($class, $restTest, $driver) = @_;
    my $path = $restTest->get_routePath();
    my $testContext = $restTest->get_testContext();
    
    $driver->get_ok($path => {Accept => 'text/json'});
    $driver->status_is(404);
    
    return 1;
}

sub get_n_200 {
    my ($class, $restTest, $driver) = @_;
    my $testContext = $restTest->get_testContext();
    my $activeUser = $restTest->get_activeBorrower();
    my $path = $restTest->get_routePath();
    
    #Create the test context.
    my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
                        {
                            subject => "The quick brown fox",
                            content => "Jumps over the lazy dog.",
                            cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
                            message_transport_type => 'sms',
                            from_address => '11A002@example.com',
                        }, undef, $testContext, undef, undef);

    my $messagenumber = $messages->{'11A002@example.com'}->{message_id};
    $path =~ s/\{messagenumber\}/$messagenumber/;
           
    $driver->get_ok($path => {Accept => 'text/json'});
    $driver->status_is(200);

    $driver->json_is('/message_id' => $messagenumber, "Message $messagenumber found!");

    return 1;
}

sub get_n_404 {
    my ($class, $restTest, $driver) = @_;
    my $path = $restTest->get_routePath();
           
    $path =~ s/\{messagenumber\}/12349329003007/;
    $driver->get_ok($path => {Accept => 'text/json'});
    $driver->status_is(404);
    
    return 1;
}

sub post201 {
    my ($class, $restTest, $driver) = @_;
    my $path = $restTest->get_routePath();
    my $activeUser = $restTest->get_activeBorrower();
    
    $driver->post_ok($path => {Accept => 'text/json'} => json => {
            subject => "hello",
            content => "world",
            message_transport_type => "email",
            borrowernumber => $activeUser->{'_result'}->{'_column_data'}->{borrowernumber},
        });
    $driver->status_is(201);
    
    # dequeue the message right after so that get 404 tests will work
    my $json = $driver->tx->res->json();
    C4::Letters::DequeueLetter({ message_id => $json->{message_id} });
    
    return 1;
}

sub post400 {
    my ($class, $restTest, $driver) = @_;
    my $path = $restTest->get_routePath();
    my $activeUser = $restTest->get_activeBorrower();
    
    #post with missing mandatory parameters
    $driver->post_ok($path => {Accept => 'text/json'} => json => {
            subject => "hello"
        });
    $driver->status_is(400);
    
    return 1;
}

sub post_n_resend204 {
    my ($class, $restTest, $driver) = @_;
    my $testContext = $restTest->get_testContext();
    my $activeUser = $restTest->get_activeBorrower();
    my $path = $restTest->get_routePath();
    
    #Create the test context.
    my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
                        {
                            subject => "The quick brown fox",
                            content => "Jumps over the lazy dog.",
                            cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
                            message_transport_type => 'sms',
                            from_address => '11A003@example.com',
                        }, undef, $testContext, undef, undef);

    # send and get the message
    C4::Letters::SendQueuedMessages();
    my $message = C4::Letters::GetMessage($messages->{'11A003@example.com'}->{message_id});
    my $messagenumber = $messages->{'11A003@example.com'}->{message_id};
    $path =~ s/\{messagenumber\}/$messagenumber/;
           
    # sms status should be failed
    is($message->{status}, "failed", "Send failed correctly");
    
    $driver->post_ok($path => {Accept => 'text/json'});
    $driver->status_is(204);

    $message = C4::Letters::GetMessage($messages->{'11A003@example.com'}->{message_id});
    is($message->{status}, "pending", "Resend set message status to pending correctly");

    return 1;
}

sub post_n_resend404 {
    my ($class, $restTest, $driver) = @_;
    my $path = $restTest->get_routePath();

    $path =~ s/\{messagenumber\}/12349329003007/;
    $driver->post_ok($path => {Accept => 'text/json'});
    $driver->status_is(404);

    return 1;
}

sub put_n_200 {
    my ($class, $restTest, $driver) = @_;
    my $testContext = $restTest->get_testContext();
    my $activeUser = $restTest->get_activeBorrower();
    my $path = $restTest->get_routePath();
    
    #Create the test context.
    my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
                        {
                            subject => "The quick brown fox",
                            content => "Jumps over the lazy dog.",
                            cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
                            message_transport_type => 'sms',
                            from_address => '11A003@example.com',
                        }, undef, $testContext, undef, undef);

    my $messagenumber = $messages->{'11A003@example.com'}->{message_id};
    $path =~ s/\{messagenumber\}/$messagenumber/;
           
    $driver->put_ok($path => {Accept => 'text/json'} => json => {
            subject => "hello",
            content => "world",
        });
    $driver->status_is(200);
    
    my $json = $driver->tx->res->json();
    is($json->{subject}, "hello", "Put updated message subject correctly");

    return 1;
}

sub put_n_400 {
    my ($class, $restTest, $driver) = @_;
    my $testContext = $restTest->get_testContext();
    my $activeUser = $restTest->get_activeBorrower();
    my $path = $restTest->get_routePath();
    
    $path =~ s/\{messagenumber\}/12349329003007/;
    $driver->put_ok($path => {Accept => 'text/json'} => json => {
            message_transport_type => "hello", #invalid transport type
        });
    $driver->status_is(400);
    
    return 1;
}

sub put_n_404 {
    my ($class, $restTest, $driver) = @_;
    my $path = $restTest->get_routePath();
           
    $path =~ s/\{messagenumber\}/12349329003007/;
    $driver->put_ok($path => {Accept => 'text/json'});
    $driver->status_is(404);
    
    return 1;
}

sub delete_n_204 {
    my ($class, $restTest, $driver) = @_;
    my $testContext = $restTest->get_testContext();
    my $activeUser = $restTest->get_activeBorrower();
    my $path = $restTest->get_routePath();
    
    #Create the test context.
    my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
                        {
                            subject => "The quick brown fox",
                            content => "Jumps over the lazy dog.",
                            cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
                            message_transport_type => 'sms',
                            from_address => '11A004@example.com',
                        }, undef, $testContext, undef, undef);

    my $messagenumber = $messages->{'11A004@example.com'}->{message_id};
    $path =~ s/\{messagenumber\}/$messagenumber/;
           
    $driver->delete_ok($path => {Accept => 'text/json'});
    $driver->status_is(204);
    
    return 1;
}

sub delete_n_404 {
    my ($class, $restTest, $driver) = @_;
    my $path = $restTest->get_routePath();
           
    $path =~ s/\{messagenumber\}/12349329003007/;
    $driver->delete_ok($path => {Accept => 'text/json'});
    $driver->status_is(404);
    
    return 1;
}

1;

Lines 18-24 Link Here

(-)a/t/db_dependent/Letters.t (-2 / +14 lines)
18	# along with Koha; if not, see <http://www.gnu.org/licenses>.	18	# along with Koha; if not, see <http://www.gnu.org/licenses>.
19		19
20	use Modern::Perl;	20	use Modern::Perl;
21	use Test::More tests => 74;	21	use Test::More tests => 79;
22	use Test::MockModule;	22	use Test::MockModule;
23	use Test::Warn;	23	use Test::Warn;
24		24
Lines 134-139 is( $messages->[0]->{message_transport_type}, $my_message->{message_transport_ty Link Here
134	is( $messages->[0]->{status}, 'pending', 'EnqueueLetter stores the status pending correctly' );	134	is( $messages->[0]->{status}, 'pending', 'EnqueueLetter stores the status pending correctly' );
135	is( $messages->[0]->{delivery_note}, '', 'Delivery note for successful message correctly empty');	135	is( $messages->[0]->{delivery_note}, '', 'Delivery note for successful message correctly empty');
136		136
		137	my $message_by_id = C4::Letters::GetQueuedMessages({ message_id => $messages->[0]->{message_id} });
		138	is ($messages->[0]->{message_id}, $message_by_id->[0]->{message_id}, "GetQueuedMessages by message_id gets correct one");
		139
137	# SendQueuedMessages	140	# SendQueuedMessages
138	my $messages_processed = C4::Letters::SendQueuedMessages();	141	my $messages_processed = C4::Letters::SendQueuedMessages();
139	is($messages_processed, 1, 'all queued messages processed');	142	is($messages_processed, 1, 'all queued messages processed');
Lines 158-163 is( $resent, undef, 'ResendMessage should return undef if not message_id given' Link Here
158	# Delivery notes	161	# Delivery notes
159	is($messages->[0]->{delivery_note}, 'Missing SMS number', 'Delivery note for no smsalertnumber correctly set');	162	is($messages->[0]->{delivery_note}, 'Missing SMS number', 'Delivery note for no smsalertnumber correctly set');
160		163
		164	# UpdateQueuedMessage
		165	is(C4::Letters::UpdateQueuedMessage({ message_id => $messages->[0]->{message_id}, content => "changed content" } ), 1, "Message updated correctly");
		166	$messages = C4::Letters::GetQueuedMessages();
		167	is($messages->[0]->{content}, "changed content", "Message content was changed correctly");
		168
161	# Test connectivity Exception (Bug 14791)	169	# Test connectivity Exception (Bug 14791)
162	ModMember(borrowernumber => $borrowernumber, smsalertnumber => "+1234567890");	170	ModMember(borrowernumber => $borrowernumber, smsalertnumber => "+1234567890");
163	warning_is { $messages_processed = C4::Letters::SendQueuedMessages(); }	171	warning_is { $messages_processed = C4::Letters::SendQueuedMessages(); }
Lines 169-174 is( $messages->[0]->{status}, 'pending', Link Here
169	is( $messages->[0]->{delivery_note}, 'Connection failed. Attempting to resend.',	177	is( $messages->[0]->{delivery_note}, 'Connection failed. Attempting to resend.',
170	'Message has correct delivery note about resending' );	178	'Message has correct delivery note about resending' );
171		179
		180	#DequeueLetter
		181	is(C4::Letters::DequeueLetter( { message_id => $messages->[0]->{message_id} } ), 1, "message successfully dequeued");
		182	$messages = C4::Letters::GetQueuedMessages();
		183	is( @$messages, 0, 'no messages left after dequeue' );
		184
172	# GetLetters	185	# GetLetters
173	my $letters = C4::Letters::GetLetters();	186	my $letters = C4::Letters::GetLetters();
174	is( @$letters, 0, 'GetLetters returns the correct number of letters' );	187	is( @$letters, 0, 'GetLetters returns the correct number of letters' );
175	-

Return to bug 14843

Lines 935-940 ENDSQL Link Here

(-)a/C4/Letters.pm (-1 / +117 lines)
935	return $dbh->last_insert_id(undef,undef,'message_queue', undef);	935	return $dbh->last_insert_id(undef,undef,'message_queue', undef);
936	}	936	}
937		937
		938	=head2 DequeueLetter
		939
		940	my $success = DequeueLetter( { message_id => $message_id } )
		941
		942	Removes a message from message_queue
		943
		944	return 1 on success, otherwise 0
		945
		946	=cut
		947
		948	sub DequeueLetter {
		949	my $params = shift or return;
		950
		951	return unless exists $params->{'message_id'} or not $params->{'message_id'};
		952
		953	my $dbh = C4::Context->dbh();
		954	my $statement = << 'ENDSQL';
		955	DELETE FROM message_queue
		956	WHERE message_id = ?
		957	ENDSQL
		958
		959	my $sth = $dbh->prepare($statement);
		960	my $result = $sth->execute(
		961	$params->{'message_id'}, # message_id
		962	);
		963	return ($result > 0);
		964	}
		965
938	=head2 SendQueuedMessages ([$hashref])	966	=head2 SendQueuedMessages ([$hashref])
939		967
940	my $sent = SendQueuedMessages( { verbose => 1 } );	968	my $sent = SendQueuedMessages( { verbose => 1 } );
Lines 1026-1032 sub GetQueuedMessages { Link Here
1026		1054
1027	my $dbh = C4::Context->dbh();	1055	my $dbh = C4::Context->dbh();
1028	my $statement = << 'ENDSQL';	1056	my $statement = << 'ENDSQL';
1029	SELECT message_id, borrowernumber, subject, content, message_transport_type, status, time_queued, delivery_note	1057	SELECT message_id, borrowernumber, subject, content, metadata, letter_code, message_transport_type, status, time_queued, to_address, from_address, content_type, delivery_note
1030	FROM message_queue	1058	FROM message_queue
1031	ENDSQL	1059	ENDSQL
1032		1060
Lines 1051-1056 ENDSQL Link Here
1051	return $sth->fetchall_arrayref({});	1079	return $sth->fetchall_arrayref({});
1052	}	1080	}
1053		1081
		1082
		1083	=head2 UpdateQueuedMessage ([$hashref])
		1084
		1085	my $message = UpdateQueuedMessage( {
		1086	borrowernumber => '123', message_id => '100',
		1087	letter => { subject => "New subject", content => "New content" },
		1088	} );
		1089
		1090	Updates the message in message_queue. Message is identified by
		1091	required parameter message_id.
		1092
		1093	returns:
		1094	1 on success, otherwise 0
		1095
		1096	=cut
		1097
		1098	sub UpdateQueuedMessage {
		1099	my $params = shift;
		1100
		1101	if (not $params->{'message_id'}) {
		1102	warn __PACKAGE__."::UpdateQueuedMessage: param message_id is required";
		1103	return;
		1104	}
		1105
		1106	my $dbh = C4::Context->dbh();
		1107	my $statement = << 'ENDSQL';
		1108	UPDATE message_queue
		1109	SET
		1110	ENDSQL
		1111
		1112	my @query_params;
		1113
		1114	if ($params->{'borrowernumber'}) {
		1115	$statement .= " borrowernumber = ?, ";
		1116	push @query_params, $params->{'borrowernumber'};
		1117	}
		1118	if ($params->{'subject'}) {
		1119	$statement .= " subject = ?, ";
		1120	push @query_params, $params->{'subject'};
		1121	}
		1122	if ($params->{'content'}) {
		1123	$statement .= " content = ?, ";
		1124	push @query_params, $params->{'content'};
		1125	}
		1126	if ($params->{'metadata'}) {
		1127	$statement .= " metadata = ?, ";
		1128	push @query_params, $params->{'metadata'};
		1129	}
		1130	if ($params->{'letter_code'}) {
		1131	$statement .= " letter_code = ?, ";
		1132	push @query_params, $params->{'letter_code'};
		1133	}
		1134	if ($params->{'content_type'}) {
		1135	$statement .= " content_type = ?, ";
		1136	push @query_params, $params->{'content_type'};
		1137	}
		1138	if ($params->{'message_transport_type'}) {
		1139	$statement .= " message_transport_type = ?, ";
		1140	push @query_params, $params->{'message_transport_type'};
		1141	}
		1142	if ($params->{'status'}) {
		1143	$statement .= " status = ?, ";
		1144	push @query_params, $params->{'status'};
		1145	}
1146	if ($params->{'to_address'}) {
1147	$statement .= " to_address = ?, ";
1148	push @query_params, $params->{'to_address'};
1149	}
1150	if ($params->{'from_address'}) {
1151	$statement .= " from_address = ?, ";
1152	push @query_params, $params->{'from_address'};
1153	}
1154	if ($params->{'delivery_note'}) {
1155	$statement .= " delivery_note = ?, ";
1156	push @query_params, $params->{'delivery_note'};
1157	}
1158	return 0 if $statement =~ /SET(\s*)$/;
1159	$statement =~ s/,(\s*)$//g; # remove last ,
1160
1161	$statement .= " WHERE message_id = ?";
1162	push @query_params, $params->{'message_id'};
1163
1164	my $sth = $dbh->prepare( $statement );
1165	my $result = $sth->execute( @query_params );
1166	return ($result > 0);
1167	}
1168
1169
1054	=head2 GetMessageTransportTypes	1170	=head2 GetMessageTransportTypes
1055		1171
1056	my @mtt = GetMessageTransportTypes();	1172	my @mtt = GetMessageTransportTypes();

Line 0 Link Here

(-)a/Koha/REST/V1/Messages.pm (+292 lines)
		1	package Koha::REST::V1::Messages;
		2
		3	use Modern::Perl;
		4
		5	use Mojo::Base 'Mojolicious::Controller';
		6
		7	use C4::Letters;
		8	use Data::Dumper;
		9	use C4::Log;
		10
		11
		12	=head2 list_messages($c, $args, $cb)
		13
		14	Lists all messages from message_queue.
		15
		16	=cut
		17	sub list_messages {
		18	my ($c, $args, $cb) = @_;
		19
		20	my $messages = C4::Letters::GetQueuedMessages();
		21
		22	if (@$messages > 0) {
		23	my $return_messages;
		24	foreach my $message (@$messages){
		25	push @$return_messages, _set_default_values({ message => $message });
		26	}
		27	return $c->$cb($return_messages , 200);
		28	}
		29	$c->$cb({ error => "No messages found." }, 404);
		30	}
		31
		32
		33
		34	=head2 create_message($c, $args, $cb)
		35
		36	Creates a new message into message queue.
		37
		38	=cut
		39	sub create_message {
		40	my ($c, $args, $cb) = @_;
		41
		42	# Content is required. Check for missing content.
		43	if (exists $args->{body}->{content}) {
		44	my $content = $args->{body}->{content};
		45	$content =~ s/\s+//g if(defined $content);
		46	if ( not $content ) {
		47	return $c->$cb({ error => "Property cannot be empty in: /body/content" }, 400);
		48	}
		49	} else {
		50	return $c->$cb({ error => "Missing property: /body/content" }, 400);
		51	}
		52
		53	if (exists $args->{body}->{borrowernumber}) {
		54	my $content = $args->{body}->{borrowernumber};
		55	$content =~ s/\s+//g if(defined $content);
		56	if ( not $content ) {
		57	return $c->$cb({ error => "Property cannot be empty in: /body/borrowernumber" }, 400);
		58	}
		59	} else {
		60	return $c->$cb({ error => "Missing property: /body/borrowernumber" }, 400);
		61	}
		62
		63
		64	# message_transport_type is required. Check for missing parameter.
65	my $transport_type = $args->{body}->{message_transport_type};
66	$transport_type =~ s/\s+//g if(defined $transport_type);
67	if ( not $transport_type ) {
68	return $c->$cb({ error => "Missing property: /body/message_transport_type" }, 400);
69	}
70
71	# message_transport_type also must be one of the predefined values
72	my $transport_types = C4::Letters::GetMessageTransportTypes();
73	if ( !grep( /^$transport_type$/, @$transport_types ) ) {
74	return $c->$cb({ error => "Invalid value '".$transport_type."' in: /body/message_transport_type. Valid values are ". join(', ', @$transport_types) }, 400);
75	}
76
77	# Make some changes in names of parameters due to inconsistent naming in C4::Letters
78
79	# Enqueue the letter
80	my $message = C4::Letters::EnqueueLetter(_convert_to_enqueue({ message => $args->{'body'} }));
81
82	# Check if the message was enqueued
83	if ($message){
84	# Get the newly created message and return it
85	$message = C4::Letters::GetMessage( $message );
86
87	$message = _set_default_values({ message => $message });
88
89	&logaction(
90	"NOTICES",
91	"CREATE",
92	$message->{message_id},
93	""
94	);
95
96	return $c->$cb($message, 201);
97	}
98	$c->$cb({ error => "Message could not be created." }, 404)
99	}
100
101
102
103	=head2 update_message($c, $args, $cb)
104
105	Updates the message in message_queue.
106
107	=cut
108	sub update_message {
109	my ($c, $args, $cb) = @_;
110
111	# Content is required. Check for missing content.
112	if (exists $args->{body}->{content}) {
113	my $content = $args->{body}->{content};
114	$content =~ s/\s+//g if(defined $content);
115	if ( $content eq '' ) {
116	return $c->$cb({ error => "Property cannot be empty in: /body/content" }, 400);
117	}
118	}
119
120	if (exists $args->{body}->{message_transport_type}) {
121	my $transport_type = $args->{body}->{message_transport_type};
122	# message_transport_type also must be one of the predefined values
123	my $transport_types = C4::Letters::GetMessageTransportTypes();
124	if ( !grep( /^$transport_type$/, @$transport_types ) ) {
125	return $c->$cb({ error => "Invalid value '".$transport_type
126	."' in: /body/message_transport_type. Valid values are "
127	. join(', ', @$transport_types) }, 400);
128	}
129	}
130
131	# create update hash
132	my $update = $args->{'body'};
133	$update->{'message_id'} = $args->{'messagenumber'};
134
135	my $message = C4::Letters::UpdateQueuedMessage( $update );
136	return $c->$cb({ error => "Message could not be found." }, 404) if not $message;
137
138	$message = C4::Letters::GetMessage($args->{'messagenumber'});
139
140	if ($message){
141	$message = _set_default_values({ message => $message });
142
143	&logaction(
144	"NOTICES",
145	"UPDATE",
146	$message->{message_id},
147	""
148	);
149
150	return $c->$cb($message, 200);
151	}
152	$c->$cb({ error => "Message could not be updated." }, 404);
153	}
154
155
156
157	=head2 delete_message($c, $args, $cb)
158
159	Delete the message from message_queue.
160
161	=cut
162	sub delete_message {
163	my ($c, $args, $cb) = @_;
164
165	my $message = C4::Letters::DequeueLetter({ message_id => $args->{'messagenumber'} });
166
167	if ($message){
168
169	&logaction(
170	"NOTICES",
171	"DELETE",
172	$args->{'messagenumber'},
173	""
174	);
175
176	return $c->$cb('', 204);
177	}
178
179	$c->$cb({ error => "Message could not be found." }, 404)
180	}
181
182
183
184	=head2 get_message($c, $args, $cb)
185
186	Returns a message from message_queue.
187
188	=cut
189	sub get_message {
190	my ($c, $args, $cb) = @_;
191
192	my $message = C4::Letters::GetMessage($args->{'messagenumber'});
193
194	if ($message) {
195	my $message = _set_default_values({ message => $message });
196
197	return $c->$cb($message, 200);
198	}
199
200	return $c->$cb({ error => "Could not find the message" }, 404);
201	}
202
203
204
205	=head2 create_resend($c, $args, $cb)
206
207	Attempts to resend a message.
208
209	=cut
210	sub create_resend {
211	my ($c, $args, $cb) = @_;
212
213
214	my $message = C4::Letters::GetMessage($args->{'messagenumber'});
215
216	if ($message) {
217	if (C4::Letters::ResendMessage($args->{'messagenumber'})) {
218
219	&logaction(
220	"NOTICES",
221	"RESEND",
222	$message->{message_id},
223	""
224	);
225
226	return $c->$cb('', 204);
227	}
228	}
229
230	return $c->$cb({ error => "Could not find the message" }, 404);
231	}
232
233
234
235	=head2 _set_default_values({ message => $message })
236
237	=cut
238	sub _set_default_values {
239	my $params = shift;
240
241	return unless exists $params->{'message'} or not defined $params->{'message'};
242
243	# Convert the returned message into C4::Letters::EnqueueLetter format
244	return {
245	message_id => int($params->{'message'}->{'message_id'}),
246	borrowernumber => int($params->{'message'}->{'borrowernumber'}),
247	subject => $params->{'message'}->{'subject'} \|\| '',
248	content => $params->{'message'}->{'content'} \|\| '',
249	letter_code => $params->{'message'}->{'letter_code'} \|\| '',
250	content_type => $params->{'message'}->{'content_type'} \|\| '',
251	metadata => $params->{'message'}->{'metadata'} \|\| '',
252	message_transport_type => $params->{'message'}->{'message_transport_type'} \|\| '',
253	to_address => $params->{'message'}->{'to_address'} \|\| '',
254	from_address => $params->{'message'}->{'from_address'} \|\| '',
255	delivery_note => $params->{'message'}->{'delivery_note'} \|\| '',
256	status => $params->{'message'}->{'status'} \|\| '',
257	time_queued => $params->{'message'}->{'time_queued'} \|\| ''
258	};
259	}
260
261
262
263	=head2 _convert_to_message({ message => $message })
264
265	Due to inconsistent naming in C4::Letters::EnqueueLetter, we use the
266	database format and convert it in this function into the format that
267	EnqueueLetter supports.
268
269	=cut
270	sub _convert_to_enqueue {
271	my $params = shift;
272
273	return unless exists $params->{'message'} or not defined $params->{'message'};
274
275	# Convert the returned message into C4::Letters::EnqueueLetter format
276	return {
277	borrowernumber => int($params->{'message'}->{'borrowernumber'}),
278	letter => {
279	title => $params->{'message'}->{'subject'} \|\| '',
280	content => $params->{'message'}->{'content'} \|\| '',
281	code => $params->{'message'}->{'letter_code'} \|\| '',
282	'content-type' => $params->{'message'}->{'content_type'} \|\| '',
283	metadata => $params->{'message'}->{'metadata'} \|\| '',
284	},
285	message_transport_type => $params->{'message'}->{'message_transport_type'} \|\| '',
286	to_address => $params->{'message'}->{'to_address'} \|\| '',
287	from_address => $params->{'message'}->{'from_address'} \|\| '',
288	delivery_note => $params->{'message'}->{'delivery_note'} \|\| ''
289	};
290	}
291
292	1;

Lines 309-314 Link Here

(-)a/api/v1/swagger.json (+262 lines)
309	}	309	}
310	}	310	}
311	}	311	}
		312	},
		313	"/messages": {
		314	"get": {
		315	"x-mojo-controller": "Koha::REST::V1::Messages",
		316	"operationId": "listMessages",
		317	"x-koha-permission": {
		318	"messages": "get_message"
		319	},
		320	"tags": ["messages"],
		321	"produces": [
		322	"application/json"
		323	],
		324	"responses": {
		325	"200": {
		326	"description": "A list of messages",
		327	"schema": {
		328	"type": "array",
		329	"items": {
		330	"$ref" : "#/definitions/message"
		331	}
		332	}
		333	},
		334	"404": {
		335	"description": "Messages not found",
		336	"schema": {
		337	"$ref": "#/definitions/error"
		338	}
		339	}
		340	}
		341	},
		342	"post": {
		343	"x-mojo-controller": "Koha::REST::V1::Messages",
		344	"operationId": "createMessage",
		345	"x-koha-permission": {
		346	"messages": "create_message"
		347	},
		348	"tags": ["messages"],
		349	"parameters": [
		350	{
		351	"name": "body",
		352	"in": "body",
		353	"description": "A JSON object containing informations about the new message",
		354	"required": true,
		355	"schema": { "$ref": "#/definitions/message" }
		356	}
		357	],
		358	"produces": [
		359	"application/json"
		360	],
		361	"responses": {
		362	"201": {
		363	"description": "A message",
		364	"schema": {
		365	"$ref": "#/definitions/message"
		366	}
		367	},
		368	"400": {
		369	"description": "Missing or wrong parameters",
		370	"schema": { "$ref": "#/definitions/error" }
		371	}
		372	}
		373	}
		374	},
		375	"/messages/{messagenumber}": {
376	"put": {
377	"x-mojo-controller": "Koha::REST::V1::Messages",
378	"operationId": "updateMessage",
379	"x-koha-permission": {
380	"messages": "update_message"
381	},
382	"tags": ["messages"],
383	"parameters": [
384	{
385	"name": "body",
386	"in": "body",
387	"description": "A JSON object containing informations about the new message",
388	"required": false,
389	"schema": { "$ref": "#/definitions/message" }
390	},
391	{
392	"$ref": "#/parameters/messagenumberPathParam"
393	}
394	],
395	"produces": [
396	"application/json"
397	],
398	"responses": {
399	"200": {
400	"description": "A message",
401	"schema": {
402	"$ref" : "#/definitions/message"
403	}
404	},
405	"400": {
406	"description": "Missing or wrong parameters",
407	"schema": { "$ref": "#/definitions/error" }
408	},
409	"404": {
410	"description": "Message not found",
411	"schema": {
412	"$ref": "#/definitions/error"
413	}
414	}
415	}
416	},
417	"delete": {
418	"x-mojo-controller": "Koha::REST::V1::Messages",
419	"operationId": "deleteMessage",
420	"x-koha-permission": {
421	"messages": "delete_message"
422	},
423	"tags": ["messages"],
424	"parameters": [
425	{
426	"$ref": "#/parameters/messagenumberPathParam"
427	}
428	],
429	"produces": [
430	"application/json"
431	],
432	"responses": {
433	"204": {
434	"description": "Deleting the message succeeded.",
435	"schema": {
436	"type": "string"
437	}
438	},
439	"404": {
440	"description": "Message not found.",
441	"schema": {
442	"$ref": "#/definitions/error"
443	}
444	}
445	}
446	},
447	"get": {
448	"x-mojo-controller": "Koha::REST::V1::Messages",
449	"operationId": "getMessage",
450	"x-koha-permission": {
451	"messages": "get_message"
452	},
453	"tags": ["messages"],
454	"parameters": [
455	{
456	"$ref": "#/parameters/messagenumberPathParam"
457	}
458	],
459	"produces": [
460	"application/json"
461	],
462	"responses": {
463	"200": {
464	"description": "A message",
465	"schema": {
466	"$ref" : "#/definitions/message"
467	}
468	},
469	"404": {
470	"description": "Message not found",
471	"schema": {
472	"$ref": "#/definitions/error"
473	}
474	}
475	}
476	}
477	},
478	"/messages/{messagenumber}/resend": {
479	"post": {
480	"x-mojo-controller": "Koha::REST::V1::Messages",
481	"operationId": "createResend",
482	"description": "Resends a message.",
483	"x-koha-permission": {
484	"messages": "resend_message"
485	},
486	"tags": ["messages"],
487	"parameters": [
488	{
489	"$ref": "#/parameters/messagenumberPathParam"
490	}
491	],
492	"produces": [
493	"application/json"
494	],
495	"responses": {
496	"204": {
497	"description": "Resending the message succeeded.",
498	"schema": {
499	"type": "string"
500	}
501	},
502	"404": {
503	"description": "Message not found",
504	"schema": {
505	"$ref": "#/definitions/error"
506	}
507	}
508	}
509	}
312	}	510	}
313	},	511	},
314	"definitions": {	512	"definitions": {
Lines 485-496 Link Here
485	"borrowernumber": {	683	"borrowernumber": {
486	"description": "Borrower internal identifier"	684	"description": "Borrower internal identifier"
487	},	685	},
		686
488	"branchcode": {	687	"branchcode": {
489	"description": "Branch code"	688	"description": "Branch code"
490	},	689	},
491	"itemnumber": {	690	"itemnumber": {
492	"description": "Item internal identifier"	691	"description": "Item internal identifier"
493	},	692	},
		693	"message": {
		694	"type": "object",
		695	"properties": {
		696	"message_id": {
		697	"description": "Message internal identifier",
		698	"type": "integer"
		699	},
		700	"time_queued": {
		701	"description": "Date and time of when message was placed in queue",
		702	"type": "string"
		703	},
		704	"borrowernumber": {
		705	"$ref": "#/definitions/borrowernumber"
		706	},
		707	"subject": {
		708	"description": "Subject of the message",
		709	"type": "string"
		710	},
		711	"content": {
		712	"description": "Content of the message",
		713	"type": "string"
		714	},
		715	"metadata": {
		716	"description": "",
		717	"type": "string"
		718	},
		719	"letter_code": {
		720	"description": "",
		721	"type": "string"
		722	},
		723	"content_type": {
		724	"description": "Content type",
		725	"type": "string"
		726	},
		727	"message_transport_type": {
		728	"description": "Transport method. Values accepted by default are 'email', 'sms', 'phone' and 'print'",
		729	"type": "string"
		730	},
		731	"status": {
		732	"description": "Delivery status",
		733	"type": "string"
		734	},
		735	"to_address": {
		736	"description": "Destination email address",
		737	"type": "string"
		738	},
		739	"from_address": {
		740	"description": "Source address of email",
		741	"type": "string"
		742	},
		743	"delivery_note": {
		744	"description": "Additional delivery notes",
		745	"type": "string"
		746	}
		747	}
		748	},
494	"error": {	749	"error": {
495	"type": "object",	750	"type": "object",
496	"properties": {	751	"properties": {
Lines 529-534 Link Here
529	"description": "Internal item identifier",	784	"description": "Internal item identifier",
530	"required": "true",	785	"required": "true",
531	"type": "integer"	786	"type": "integer"
		787	},
		788	"messagenumberPathParam": {
		789	"name": "messagenumber",
		790	"in": "path",
		791	"description": "Internal message identifier",
		792	"required": "true",
		793	"type": "integer"
532	}	794	}
533	},	795	},
534	"securityDefinitions": {	796	"securityDefinitions": {

Line 0 Link Here

(-)a/installer/data/mysql/atomicupdate/Bug14767-Add_Permissions_for_message_queue_REST_operations.pl (+38 lines)
	1	#!/usr/bin/perl
	2
	3	# Copyright Open Source Freedom Fighters
	4	#
	5	# This file is part of Koha.
	6	#
	7	# Koha is free software; you can redistribute it and/or modify it under the
	8	# terms of the GNU General Public License as published by the Free Software
	9	# Foundation; either version 3 of the License, or (at your option) any later
	10	# version.
	11	#
	12	# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
	13	# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
	14	# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
	15	#
	16	# You should have received a copy of the GNU General Public License along
	17	# with Koha; if not, write to the Free Software Foundation, Inc.,
	18	# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	19
	20	use C4::Context;
	21	use Koha::AtomicUpdater;
	22
	23	my $dbh = C4::Context->dbh();
	24	my $atomicUpdater = Koha::AtomicUpdater->new();
	25
	26	unless($atomicUpdater->find('Bug14767-Add_Permissions_for_message_queue_REST_operations.pl')) {
	27
	28	use Koha::Auth::PermissionManager;
	29	my $pm = Koha::Auth::PermissionManager->new();
	30	$pm->addPermissionModule({module => 'messages', description => 'Permission regarding notifications and messages in message queue.'});
	31	$pm->addPermission({module => 'messages', code => 'get_message', description => "Allows to get the messages in message queue."});
	32	$pm->addPermission({module => 'messages', code => 'create_message', description => "Allows to create a new message and queue it."});
	33	$pm->addPermission({module => 'messages', code => 'update_message', description => "Allows to update messages in message queue."});
	34	$pm->addPermission({module => 'messages', code => 'delete_message', description => "Allows to delete a message and queue it."});
	35	$pm->addPermission({module => 'messages', code => 'resend_message', description => "Allows to resend messages in message queue."});
	36
	37	print "Upgrade done (Bug 14767: Add Pemissions for message queue REST operations)\n";
	38	}

Line 0 Link Here

(-)a/t/db_dependent/Api/V1/Messages.pm (+258 lines)
		1	package t::db_dependent::Api::V1::Messages;
		2
		3	use Modern::Perl;
		4	use Test::More;
		5
		6	use t::lib::TestObjects::ObjectFactory;
		7	use t::lib::TestObjects::MessageQueueFactory;
		8
		9	use C4::Letters;
		10
		11	sub get200 {
		12	my ($class, $restTest, $driver) = @_;
		13	my $testContext = $restTest->get_testContext();
		14	my $activeUser = $restTest->get_activeBorrower();
		15	my $path = $restTest->get_routePath();
		16
		17	#Create the test context.
		18	my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
		19	{
		20	subject => "The quick brown fox",
		21	content => "Jumps over the lazy dog.",
		22	cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
		23	message_transport_type => 'sms',
		24	from_address => '11A001@example.com',
		25	}, undef, $testContext, undef, undef);
		26
		27	my $messagenumber = $messages->{'11A001@example.com'}->{message_id};
		28
		29	$driver->get_ok($path => {Accept => 'text/json'});
		30	$driver->status_is(200);
		31
		32	$driver->json_has("message_id", "Message id in JSON.");
		33
		34	return 1;
		35	}
		36
		37	sub get404 {
		38	my ($class, $restTest, $driver) = @_;
		39	my $path = $restTest->get_routePath();
		40	my $testContext = $restTest->get_testContext();
		41
		42	$driver->get_ok($path => {Accept => 'text/json'});
		43	$driver->status_is(404);
		44
		45	return 1;
		46	}
		47
		48	sub get_n_200 {
		49	my ($class, $restTest, $driver) = @_;
		50	my $testContext = $restTest->get_testContext();
		51	my $activeUser = $restTest->get_activeBorrower();
		52	my $path = $restTest->get_routePath();
		53
		54	#Create the test context.
		55	my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
		56	{
		57	subject => "The quick brown fox",
		58	content => "Jumps over the lazy dog.",
		59	cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
		60	message_transport_type => 'sms',
		61	from_address => '11A002@example.com',
		62	}, undef, $testContext, undef, undef);
		63
		64	my $messagenumber = $messages->{'11A002@example.com'}->{message_id};
65	$path =~ s/\{messagenumber\}/$messagenumber/;
66
67	$driver->get_ok($path => {Accept => 'text/json'});
68	$driver->status_is(200);
69
70	$driver->json_is('/message_id' => $messagenumber, "Message $messagenumber found!");
71
72	return 1;
73	}
74
75	sub get_n_404 {
76	my ($class, $restTest, $driver) = @_;
77	my $path = $restTest->get_routePath();
78
79	$path =~ s/\{messagenumber\}/12349329003007/;
80	$driver->get_ok($path => {Accept => 'text/json'});
81	$driver->status_is(404);
82
83	return 1;
84	}
85
86	sub post201 {
87	my ($class, $restTest, $driver) = @_;
88	my $path = $restTest->get_routePath();
89	my $activeUser = $restTest->get_activeBorrower();
90
91	$driver->post_ok($path => {Accept => 'text/json'} => json => {
92	subject => "hello",
93	content => "world",
94	message_transport_type => "email",
95	borrowernumber => $activeUser->{'_result'}->{'_column_data'}->{borrowernumber},
96	});
97	$driver->status_is(201);
98
99	# dequeue the message right after so that get 404 tests will work
100	my $json = $driver->tx->res->json();
101	C4::Letters::DequeueLetter({ message_id => $json->{message_id} });
102
103	return 1;
104	}
105
106	sub post400 {
107	my ($class, $restTest, $driver) = @_;
108	my $path = $restTest->get_routePath();
109	my $activeUser = $restTest->get_activeBorrower();
110
111	#post with missing mandatory parameters
112	$driver->post_ok($path => {Accept => 'text/json'} => json => {
113	subject => "hello"
114	});
115	$driver->status_is(400);
116
117	return 1;
118	}
119
120	sub post_n_resend204 {
121	my ($class, $restTest, $driver) = @_;
122	my $testContext = $restTest->get_testContext();
123	my $activeUser = $restTest->get_activeBorrower();
124	my $path = $restTest->get_routePath();
125
126	#Create the test context.
127	my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
128	{
129	subject => "The quick brown fox",
130	content => "Jumps over the lazy dog.",
131	cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
132	message_transport_type => 'sms',
133	from_address => '11A003@example.com',
134	}, undef, $testContext, undef, undef);
135
136	# send and get the message
137	C4::Letters::SendQueuedMessages();
138	my $message = C4::Letters::GetMessage($messages->{'11A003@example.com'}->{message_id});
139	my $messagenumber = $messages->{'11A003@example.com'}->{message_id};
140	$path =~ s/\{messagenumber\}/$messagenumber/;
141
142	# sms status should be failed
143	is($message->{status}, "failed", "Send failed correctly");
144
145	$driver->post_ok($path => {Accept => 'text/json'});
146	$driver->status_is(204);
147
148	$message = C4::Letters::GetMessage($messages->{'11A003@example.com'}->{message_id});
149	is($message->{status}, "pending", "Resend set message status to pending correctly");
150
151	return 1;
152	}
153
154	sub post_n_resend404 {
155	my ($class, $restTest, $driver) = @_;
156	my $path = $restTest->get_routePath();
157
158	$path =~ s/\{messagenumber\}/12349329003007/;
159	$driver->post_ok($path => {Accept => 'text/json'});
160	$driver->status_is(404);
161
162	return 1;
163	}
164
165	sub put_n_200 {
166	my ($class, $restTest, $driver) = @_;
167	my $testContext = $restTest->get_testContext();
168	my $activeUser = $restTest->get_activeBorrower();
169	my $path = $restTest->get_routePath();
170
171	#Create the test context.
172	my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
173	{
174	subject => "The quick brown fox",
175	content => "Jumps over the lazy dog.",
176	cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
177	message_transport_type => 'sms',
178	from_address => '11A003@example.com',
179	}, undef, $testContext, undef, undef);
180
181	my $messagenumber = $messages->{'11A003@example.com'}->{message_id};
182	$path =~ s/\{messagenumber\}/$messagenumber/;
183
184	$driver->put_ok($path => {Accept => 'text/json'} => json => {
185	subject => "hello",
186	content => "world",
187	});
188	$driver->status_is(200);
189
190	my $json = $driver->tx->res->json();
191	is($json->{subject}, "hello", "Put updated message subject correctly");
192
193	return 1;
194	}
195
196	sub put_n_400 {
197	my ($class, $restTest, $driver) = @_;
198	my $testContext = $restTest->get_testContext();
199	my $activeUser = $restTest->get_activeBorrower();
200	my $path = $restTest->get_routePath();
201
202	$path =~ s/\{messagenumber\}/12349329003007/;
203	$driver->put_ok($path => {Accept => 'text/json'} => json => {
204	message_transport_type => "hello", #invalid transport type
205	});
206	$driver->status_is(400);
207
208	return 1;
209	}
210
211	sub put_n_404 {
212	my ($class, $restTest, $driver) = @_;
213	my $path = $restTest->get_routePath();
214
215	$path =~ s/\{messagenumber\}/12349329003007/;
216	$driver->put_ok($path => {Accept => 'text/json'});
217	$driver->status_is(404);
218
219	return 1;
220	}
221
222	sub delete_n_204 {
223	my ($class, $restTest, $driver) = @_;
224	my $testContext = $restTest->get_testContext();
225	my $activeUser = $restTest->get_activeBorrower();
226	my $path = $restTest->get_routePath();
227
228	#Create the test context.
229	my $messages = t::lib::TestObjects::MessageQueueFactory->createTestGroup(
230	{
231	subject => "The quick brown fox",
232	content => "Jumps over the lazy dog.",
233	cardnumber => $activeUser->{'_result'}->{'_column_data'}->{cardnumber},
234	message_transport_type => 'sms',
235	from_address => '11A004@example.com',
236	}, undef, $testContext, undef, undef);
237
238	my $messagenumber = $messages->{'11A004@example.com'}->{message_id};
239	$path =~ s/\{messagenumber\}/$messagenumber/;
240
241	$driver->delete_ok($path => {Accept => 'text/json'});
242	$driver->status_is(204);
243
244	return 1;
245	}
246
247	sub delete_n_404 {
248	my ($class, $restTest, $driver) = @_;
249	my $path = $restTest->get_routePath();
250
251	$path =~ s/\{messagenumber\}/12349329003007/;
252	$driver->delete_ok($path => {Accept => 'text/json'});
253	$driver->status_is(404);
254
255	return 1;
256	}
257
258	1;