Bug 5625 : adding missing title (needed for lateorders.pl)
[koha.git] / C4 / Members / Messaging.pm
index 899a3fb..2b39f11 100644 (file)
@@ -13,9 +13,9 @@ package C4::Members::Messaging;
 # 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., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# 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 strict;
 use warnings;
@@ -61,21 +61,23 @@ sub GetMessagingPreferences {
 
     return unless exists $params->{message_name};
     return unless exists $params->{borrowernumber} xor exists $params->{categorycode}; # yes, xor
-
     my $sql = <<'END_SQL';
 SELECT borrower_message_preferences.*,
        borrower_message_transport_preferences.message_transport_type,
-       message_attributes.*,
-       message_transports.*
-  FROM borrower_message_preferences
-  LEFT JOIN borrower_message_transport_preferences
-    ON borrower_message_transport_preferences.borrower_message_preference_id = borrower_message_preferences.borrower_message_preference_id
-  LEFT JOIN message_attributes
-    ON message_attributes.message_attribute_id = borrower_message_preferences.message_attribute_id
-  LEFT JOIN message_transports
-    ON message_transports.message_attribute_id = message_attributes.message_attribute_id
-    AND message_transports.message_transport_type = borrower_message_transport_preferences.message_transport_type
-  WHERE message_attributes.message_name = ?
+       message_attributes.message_name,
+       message_attributes.takes_days,
+       message_transports.is_digest,
+       message_transports.letter_module,
+       message_transports.letter_code
+FROM   borrower_message_preferences
+LEFT JOIN borrower_message_transport_preferences
+ON     borrower_message_transport_preferences.borrower_message_preference_id = borrower_message_preferences.borrower_message_preference_id
+LEFT JOIN message_attributes
+ON     message_attributes.message_attribute_id = borrower_message_preferences.message_attribute_id
+JOIN message_transports
+ON     message_transports.message_attribute_id = message_attributes.message_attribute_id
+AND    message_transports.message_transport_type = borrower_message_transport_preferences.message_transport_type
+WHERE  message_attributes.message_name = ?
 END_SQL
 
     my @bind_params = ( $params->{'message_name'} );
@@ -93,10 +95,9 @@ END_SQL
     my %transports; # helps build a list of unique message_transport_types
     ROW: while ( my $row = $sth->fetchrow_hashref() ) {
         next ROW unless $row->{'message_attribute_id'};
-        # warn( Data::Dumper->Dump( [ $row ], [ 'row' ] ) );
         $return->{'days_in_advance'} = $row->{'days_in_advance'} if defined $row->{'days_in_advance'};
         $return->{'wants_digest'}    = $row->{'wants_digest'}    if defined $row->{'wants_digest'};
-               $return->{'letter_code'}     = $row->{'letter_code'};
+        $return->{'letter_code'}     = $row->{'letter_code'};
         $transports{$row->{'message_transport_type'}} = 1;
     }
     @{$return->{'transports'}} = keys %transports;
@@ -191,7 +192,7 @@ END_SQL
 
   my $messaging_options = C4::Members::Messaging::GetMessagingOptions()
 
-returns a hashref of messaing options available.
+returns a hashref of messaging options available.
 
 =cut
 
@@ -212,7 +213,7 @@ END_SQL
         $choices->{ $row->{'message_name'} }->{'message_name'}         = $row->{'message_name'};
         $choices->{ $row->{'message_name'} }->{'takes_days'}           = $row->{'takes_days'};
         $choices->{ $row->{'message_name'} }->{'has_digest'}           = 1 if $row->{'is_digest'};
-        $choices->{ $row->{'message_name'} }->{'transport-' . $row->{'message_transport_type'}} = ' ';
+        $choices->{ $row->{'message_name'} }->{'transport_' . $row->{'message_transport_type'}} = ' ';
     }
 
     my @return = values %$choices;
@@ -220,6 +221,40 @@ END_SQL
     return \@return;
 }
 
+=head2 SetMessagingPreferencesFromDefaults
+
+  C4::Members::Messaging::SetMessagingPreferenceFromDefaults( { borrowernumber => $borrower->{'borrowernumber'}
+                                                                categorycode   => 'CPL' } );
+
+Given a borrowernumber and a patron category code (from the C<borrowernumber> and C<categorycode> keys
+in the parameter hashref), replace all of the patron's current messaging preferences with
+whatever defaults are defined for the patron category.
+
+=cut
+
+sub SetMessagingPreferencesFromDefaults {
+    my $params = shift;
+
+    foreach my $required ( qw( borrowernumber categorycode ) ) {
+        unless ( exists $params->{ $required } ) {
+            die "SetMessagingPreferencesFromDefaults called without required parameter: $required";
+        }
+    }
+
+    my $messaging_options = GetMessagingOptions();
+    OPTION: foreach my $option ( @$messaging_options ) {
+        my $default_pref = GetMessagingPreferences( { categorycode => $params->{categorycode},
+                                                      message_name => $option->{'message_name'} } );
+        # FIXME - except for setting the borrowernumber, it really ought to be possible
+        # to have the output of GetMessagingPreferences be able to be the input
+        # to SetMessagingPreference
+        $default_pref->{message_attribute_id}    = $option->{'message_attribute_id'};
+        $default_pref->{message_transport_types} = $default_pref->{transports};
+        $default_pref->{borrowernumber}          = $params->{borrowernumber};
+        SetMessagingPreference( $default_pref );
+    }
+}
+
 =head1 TABLES
 
 =head2 message_queue
@@ -273,7 +308,7 @@ L<C4::Letters>
 
 =head1 AUTHOR
 
-Koha Development Team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
 
 Andrew Moore <andrew.moore@liblime.com>