use parent qw(Rose::Object);
+use Carp;
+use Encode;
use English qw(-no_match_vars);
+use File::Basename ();
+use File::Copy ();
+use File::Path ();
+use List::MoreUtils qw(uniq);
+
use Rose::Object::MakeMethods::Generic (
scalar => [ qw(dbh myconfig) ],
);
sub db_error {
my ($self, $msg) = @_;
- die $self->locale->text("Database update error:") . "<br>$msg<br>" . $DBI::errstr;
+ die $::locale->text("Database update error:") . "<br>$msg<br>" . $self->db_errstr('DBI');
}
sub db_query {
- my ($self, $query, $may_fail) = @_;
+ my ($self, $query, %params) = @_;
+
+ my $dbh = $params{dbh} || $self->dbh;
- return if $self->dbh->do($query);
+ return if $dbh->do($query, undef, @{ $params{bind} || [] });
- $self->db_error($query) unless $may_fail;
+ $self->db_error($query) unless $params{may_fail};
- $self->dbh->rollback;
- $self->dbh->begin_work;
+ $dbh->rollback;
+ $dbh->begin_work;
+}
+
+sub db_errstr {
+ my ($self, $handle) = @_;
+
+ my $error = $handle ? $handle->errstr : $self->dbh->errstr;
+
+ return $::locale->is_utf8 ? Encode::decode('utf-8', $error) : $error;
}
sub check_coa {
return !$empty;
}
+sub add_print_templates {
+ my ($self, $src_dir, @files) = @_;
+
+ $::lxdebug->message(LXDebug::DEBUG1(), "add_print_templates: src_dir $src_dir files " . join(' ', @files));
+
+ foreach (@files) {
+ croak "File '${src_dir}/$_' does not exist" unless -f "${src_dir}/$_";
+ }
+
+ my %users = $::auth->read_all_users;
+ my @template_dirs = uniq map { $_ = $_->{templates}; s:/+$::; $_ } values %users;
+
+ $::lxdebug->message(LXDebug::DEBUG1(), "add_print_templates: template_dirs " . join(' ', @template_dirs));
+
+ foreach my $src_file (@files) {
+ foreach my $template_dir (@template_dirs) {
+ my $dest_file = $template_dir . '/' . $src_file;
+
+ if (-f $dest_file) {
+ $::lxdebug->message(LXDebug::DEBUG1(), "add_print_templates: dest_file exists, skipping: ${dest_file}");
+ next;
+ }
+
+ my $dest_dir = File::Basename::dirname($dest_file);
+
+ if ($dest_dir && !-d $dest_dir) {
+ File::Path::make_path($dest_dir) or die "Cannot create directory '${dest_dir}': $!";
+ }
+
+ File::Copy::copy($src_dir . '/' . $src_file, $dest_file) or die "Cannot copy '${src_dir}/${src_file}' to '${dest_file}': $!";
+
+ $::lxdebug->message(LXDebug::DEBUG1(), "add_print_templates: copied '${src_dir}/${src_file}' to '${dest_file}'");
+ }
+ }
+
+ return 1;
+}
+
1;
__END__
=back
-
=head1 FUNCTIONS
=over 4
+=item C<add_print_templates $source_dir, @files>
+
+Adds (copies) new print templates to existing users. All existing
+users in the authentication database are read. The listed C<@files>
+are copied to each user's configured templates directory preserving
+sub-directory structure (non-existing sub-directories will be
+created). If a template with the same name exists it will be skipped.
+
+The source file names must all be relative to the source directory
+C<$source_dir>. This way only the desired sub-directories are created
+in the users' template directories. Example:
+
+ $self->add_print_templates(
+ 'templates/print/Standard',
+ qw(receipt.tex common.sty images/background.png)
+ );
+
+Let's assume a user's template directory is
+C<templates/big-money-inc>. The call above would trigger five actions:
+
+=over 2
+
+=item 1. Create the directory C<templates/big-money-inc> if it doesn't
+exist.
+
+=item 2. Copy C<templates/print/Standard/receipt.tex> to
+C<templates/big-money-inc/receipt.tex> if there's no such file in that
+directory.
+
+=item 3. Copy C<templates/print/Standard/common.sty> to
+C<templates/big-money-inc/common.sty> if there's no such file in that
+directory.
+
+=item 4. Create the directory C<templates/big-money-inc/images> if it
+doesn't exist.
+
+=item 5. Copy C<templates/print/Standard/images/background.png> to
+C<templates/big-money-inc/images/background.png> if there's no such
+file in that directory.
+
+=back
+
=item C<check_coa $coa_name>
Returns trueish if the database uses the chart of accounts named
Outputs an error message C<$message> to the user and aborts execution.
-=item C<db_query $query, $may_fail>
+=item C<db_query $query, %params>
+
+Executes an SQL query. The following parameters are supported:
+
+=over 2
+
+=item C<may_fail>
+
+What the method does if the query fails depends on this parameter. If
+it is falsish (the default) then the method will simply die outputting
+the error message via L</db_error>. If C<may_fail> is trueish then the
+current transaction will be rolled back, a new one will be started.
+
+=item C<bind>
+
+An optional array reference containing bind parameter for the query.
-Executes an SQL query. What the method does if the query fails depends
-on C<$may_fail>. If it is falsish then the method will simply die
-outputting the error message via L</db_error>. If C<$may_fail> is
-trueish then the current transaction will be rolled back, a new one
-will be started
+=item C<dbh>
+
+The database handle to use. If undefined then C<$self-E<gt>dbh> will
+be used.
+
+=back
+
+=item C<db_errstr [$handle]>
+
+Returns the last database from C<$handle> error message encoded in
+Perl's internal encoding. The PostgreSQL DBD leaves the UTF-8 flag off
+for error messages even if the C<pg_enable_utf8> attribute is set.
+
+C<$handle> is optional and can be one of three things:
+
+=over 2
+
+=item 1. A database or statement handle. In that case
+C<$handle-E<gt>errstr> is used.
+
+=item 2. The string 'DBI'. In that case C<$DBI::errstr> is used.
+
+=item 3. If it is undefined then C<$self-E<gt>dbh-E<gt>errstr> is
+used.
+
+=back
=item C<execute_script>
projects / kivitendo-erp.git / blobdiff