Added new functionality to allow LaTeX generation of invoices. #875

neerdoc · 2016-12-07T19:14:34Z

Changes proposed in this pull request:

Added functionality for LaTeX invoices.

Reason for this pull request:

LaTeX is one of the most complete type setting tools there are with huge community support.

…e template is included.

kevinpapst · 2016-12-07T20:18:30Z

extensions/ki_invoice/init.php

+        } elseif (file_exists($tplFile.'/invoice.tex')) {
+            $extension = 'LaTeX';
+            //Test if we can execute pdflatex
+            $output = exec($kga['LaTeXExec']);


why don't you use is_executable($kga['LaTeXExec'])?

Didn't know about that function. I can use that instead if you like.

Yes please.

kevinpapst · 2016-12-08T07:45:31Z

Hi @neerdragon!
First of all: Thanks a lot for contributing such an interesting feature 👍 I will test it out within the next days.

One thing I would request is check(s) for the existence of the exec function, as it is deactivated in many environments (shared hosts for example) for security reasons:

if(function_exists('exec')) {
    // deactivate latex functionality
}

I would suggest that we dislay an error message instead of the input field for the executable in the admin section and then disable it in the invoice section as well.

neerdoc · 2016-12-08T15:06:36Z

Hi @kevinpapst !

Ok, I will do that! It is kind of automatically deactivated in the invoice section if it cannot execute, but I'll look into changing that. What about the error message? Is it ok to simply replace the input field with a message? Or should it be more "fancy", like a floater?

One more thing, I added a field in the database to store the executable, i.e. LaTeXExec, but I didn't dare change anything in the update database scripts... So I guess I need help with that if this is approved!

…on of the pdflatex is tested.

neerdoc · 2016-12-08T15:50:25Z

Added fixes as suggested.

simonschaufi · 2016-12-08T20:26:54Z

please no floater. otherwise it would open every time you go to admin panel which would be very annoying.

For the db migration: make sure the installer does contain the column and the updater adds it (and increment the version number!)

simonschaufi · 2016-12-08T20:29:38Z

extensions/ki_adminpanel/init.php

+    if(!function_exists('exec')) {
+        // deactivate latex functionality
+        Kimai_Logger::logfile("Cannot execute external files. LaTeX invoices will be disabled.");
+        $view->assign('canExecute', false);


I would name it "execAvailable". What do you think? canExecute sounds more like some internal stuff (object) can execute something.

Sure. I can change it!

simonschaufi · 2016-12-08T22:03:13Z

language/en.php

@@ -257,6 +257,8 @@
    "roundTimesheetEntries" => "Round new timesheet entries to",
    "minutes" => "Minutes",
    "seconds" => "Seconds",
+    "LaTeXExecutable" => "Full path to LaTeX executable, i.e., 'pdflatex'.",
+    "cannotExecute" => "Your system does not allow execution of external files. LaTeX invoice generation will be disabled.",


Maybe a link where latex can be downloaded from?

Sure, but then it needs to be updated in case the link changes... I believe anyone who wants to use LaTeX will know where to find it. If not, a simple "google LaTeX" will give you the answer... :)

neerdoc · 2016-12-08T23:14:54Z

No floater. I just changed the input field to a text instead.

simonschaufi · 2016-12-08T23:57:21Z

Where is the class Kimai_Invoice_LaTeXRenderer actually? did you forget to add it?

neerdoc · 2016-12-09T00:32:48Z

Yes, indeed I forgot to add two files... Should be all now! :/

simonschaufi · 2016-12-09T00:42:04Z

please adjust your code to make it PSR2 compatible (StyleCI check is green). click the Details link to automatically get a patch file and apply it.

simonschaufi · 2016-12-10T00:05:58Z

I had a deeper look into your code now, made some changes and improvements but here are some things to consider:

everything inside the libraries folder must be a class! Make OCR a class!
did you write the OCR completely by your own? if not, sources?
don't kill the hard drive! use as little as possible file IO.
why do you execute pdflatex twice???
please use single quotes in "normal strings"

neerdoc · 2016-12-10T02:26:05Z

Ok, I can change OCR to be a class.
Yes, I wrote the OCR function myself.
The LaTeX typesetting engine works that way. You always have to run it twice.

simonschaufi · 2016-12-10T20:52:44Z

You somehow messed up the indentation. Could you please align your code properly? If you are using phpstorm, use the autoformating, that works pretty well :D

Please also make your db changes so that this PR can be merged.

simonschaufi · 2016-12-10T20:55:01Z

libraries/Kimai/Invoice/LaTeXRenderer.php

+        //Create invoiceId
+        $in = time();
+        $invoiceID = date('y', $in) . $customer['customerID'] . date('m', $in) . date('d', $in);
+        require_once 'Checksum.php';


can be dropped as autoloading works out of the box if the class is correctly named.

simonschaufi · 2016-12-10T20:55:53Z

libraries/Kimai/Invoice/LaTeXRenderer.php

+    }
+
+    /**
+     * @return pdf


does not return anything but just output the file

Changed to "@return null".

neerdoc · 2016-12-11T11:45:19Z

@simonschaufi Please double check my change to installer.php and updater.php as I feel a bit unsure that I got it right.

simonschaufi

looks good so far but you forgot to raise the revision number in includes/version.php.

simonschaufi · 2016-12-11T13:16:35Z

installer/install.php

@@ -345,6 +345,7 @@ function quoteForSql($input) {
 ('roundSeconds', '0'),
 ('allowRoundDown', '0'),
 ('defaultStatusID', '1')


comma missing in the end

Oops.
Fixed. And increased revision by one in version.php

neerdoc · 2016-12-14T17:50:16Z

@simonschaufi It's all good now?

simonschaufi · 2016-12-14T22:34:41Z

I would like to test it myself before I merge it but didn't have the time yet.

neerdoc · 2017-08-24T17:42:25Z

@simonschaufi Any progress on this issue?

simonschaufi · 2017-08-24T20:11:37Z

Thank you for your ping!
Could you please also write some documentation how to setup a system (for all the noobs who don't know how to setup latex)? Please do that in the documentation repository.

Just for me, is this the minimal setup for ubuntu?

sudo apt-get install texlive texlive-lang-german texlive-latex-extra

neerdoc · 2017-08-24T21:44:05Z

Yes, I can add some documentation!
I'm running on FreeBSD, don't know about Ubuntu... But it should be enough to install any texlive distribution.

AaronFeldman · 2018-02-17T01:36:01Z

I would love to test this out on ubuntu 17.10!! Also, I can help proof the documentation if needed. On Ubuntu it has (at least in the past) been a bad idea to use apt-get to install texlive, because the ubuntu packages are not updated often enough, at times years behind the current distribution. The best way is to use the net installer, as described here: https://tex.stackexchange.com/a/1094/90087

dwagenk · 2019-08-28T08:10:10Z

Hey,

this is the only PR or issue related to LaTeX for templates. But it looks like it's discontinued. Any chance for merging?

I'm evaluating kimai for tracking the time I spend on various freelance projects. I've got my invoices, letter-templates and basically everything else in LaTeX, so autogenerating those from within kimai would be great!

I'm not a php/web developer, but experienced enough with self hosting things like this, so I could test changes.
Got a Debian server available, but would usally configure and spin it up inside docker containers.

Thanks in advance!
Daniel

simonschaufi · 2019-09-22T22:38:35Z

@dwagenk There are some conflicts with this branch as you can see so I can't just merge it like that. You can also checkout the source of the fork and see if that works for you. I don't want to waist too much time with Latex as you are the second person who is interested in it.

neerdoc added 2 commits December 7, 2016 19:05

Added new functionality to allow LaTeX generation of invoices. Exampl…

a762e81

…e template is included.

Added example template for LaTeX invoice.

bb903f6

kevinpapst reviewed Dec 7, 2016

View reviewed changes

simonschaufi added the Feature Request label Dec 7, 2016

Added check if exec is allowed in the system. Changed the way executi…

3e5b42a

…on of the pdflatex is tested.

simonschaufi suggested changes Dec 8, 2016

View reviewed changes

simonschaufi reviewed Dec 8, 2016

View reviewed changes

Change 'canExecute' to 'execAvaiable'. Less misleading.

da94312

Added LaTeXRenderer.php and Checksum.php

cea423a

neerdoc and others added 3 commits December 9, 2016 19:17

Fixed style of files to comply with PSR2.

8233a19

Added download link to help text in admin panel.

7d322f4

Adjust spaces

7e70e43

Further code improvements

a3fd2ff

simonschaufi approved these changes Dec 10, 2016

View reviewed changes

Further code improvements and a little bit less logging

924a933

neerdoc added 2 commits December 10, 2016 16:42

Changed Checksum to be a class.

e867de3

Fixed spaces.

e321963

simonschaufi suggested changes Dec 10, 2016

View reviewed changes

Fixed indentation.

b7f87c0

neerdoc added 2 commits December 11, 2016 11:29

Removed explicit load of file and corrected return value.

25c575d

Added necessary updates to the database.

3221e3e

simonschaufi suggested changes Dec 11, 2016

View reviewed changes

Fixed typo and increased database version number.

d426792

simonschaufi added 2 commits August 24, 2017 22:15

Update LaTeXRenderer.php

5b05193

Update LaTeXRenderer.php

c96af4e

simonschaufi approved these changes Aug 24, 2017

View reviewed changes

simonschaufi self-assigned this Aug 24, 2017

kevinpapst mentioned this pull request Aug 28, 2019

Latex support for invoices kimai/kimai#1066

Closed

Added new functionality to allow LaTeX generation of invoices. #875

Are you sure you want to change the base?

Added new functionality to allow LaTeX generation of invoices. #875

Conversation

neerdoc commented Dec 7, 2016 • edited by simonschaufi

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevinpapst commented Dec 8, 2016

neerdoc commented Dec 8, 2016

neerdoc commented Dec 8, 2016

simonschaufi commented Dec 8, 2016

simonschaufi Dec 8, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neerdoc commented Dec 8, 2016

simonschaufi commented Dec 8, 2016

neerdoc commented Dec 9, 2016

simonschaufi commented Dec 9, 2016 • edited

simonschaufi commented Dec 10, 2016 • edited

neerdoc commented Dec 10, 2016

simonschaufi commented Dec 10, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neerdoc commented Dec 11, 2016

simonschaufi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neerdoc commented Dec 14, 2016

simonschaufi commented Dec 14, 2016

neerdoc commented Aug 24, 2017

simonschaufi commented Aug 24, 2017 • edited

neerdoc commented Aug 24, 2017 • edited by simonschaufi

AaronFeldman commented Feb 17, 2018 • edited

dwagenk commented Aug 28, 2019

simonschaufi commented Sep 22, 2019

neerdoc commented Dec 7, 2016 •

edited by simonschaufi

simonschaufi Dec 8, 2016 •

edited

simonschaufi commented Dec 9, 2016 •

edited

simonschaufi commented Dec 10, 2016 •

edited

simonschaufi commented Dec 10, 2016 •

edited

simonschaufi commented Aug 24, 2017 •

edited

neerdoc commented Aug 24, 2017 •

edited by simonschaufi

AaronFeldman commented Feb 17, 2018 •

edited