PdfGenerator.cpp

/*
 * PdfGenerator.cpp
 *
 *  Created on: 29 Feb 2012
 *      Author: Max Foster
 */

#include <map>
using namespace std;

#include <QWebView>
#include <QUrl>
#include <QPrinter>
#include <QFile>

#include "PdfGenerator.h"
#include "Globals.h"
#include "Utils.h"

#include "Databases.h"
#include "Job.h"
#include "Part.h"
#include "Customer.h"
#include "Expense.h"
#include "JobController.h"
#include "CustomerController.h"
#include "ExpenseController.h"

// Attributes is a map/dictionary that has string keys and string values. A key represents a place in the HTML to
// replace with the value. E.g. The string '<$ forename $>' in the HTML code will be replaced by the value indexed by
// the string 'price' in the map, so the resulting HTML will look something like 'John'
typedef map<QString, QString> Attributes;

QString toValidFileName(const char *fileName_)
{
    // If the file name does not end with '.pdf' append '.pdf' to it
    QString fileName(fileName_);
    if (!fileName.endsWith(".pdf", Qt::CaseInsensitive)) fileName += ".pdf";
    return fileName;
}

QString getHtml(const QString &resourceName)
{
    // Read the data from the HTML resource and return it as a string
    QString returnString;
    QFile file(":html/" + resourceName);
    if (file.exists())
    {
        file.open(QFile::ReadOnly);
        if (file.isOpen())
        {
            returnString = file.readAll();
            file.close();
        }
    }
    return returnString;
}

void parseHtml(QString &html, Attributes &attributes)
{
    static const QString startTag = "<$", endTag = "$>";

    int startIndex = 0;
    QString key;

    // While there are instances of the start tag string in the HTML
    while ((startIndex = html.indexOf(startTag, startIndex)) >= 0)
    {
        // Find the end of the tag
        int substringStart = startIndex + startTag.length();

        int endIndex = html.indexOf(endTag, substringStart);
        if (endIndex < 0) break;
        int substringEnd = endIndex - endTag.length();

        while (html[substringStart] == ' ') ++substringStart;
        while (html[substringEnd] == ' ') --substringEnd;

        // Get the keyword in between the tags
        key = html.mid(substringStart, substringEnd - (substringStart - 1));

        // Replace the whole tag with a value in the attributes dictionary
        html.replace(startIndex, endIndex + endTag.length() - startIndex, attributes[key]);
    }
}

// A macro that creates a webview and attemps to get the HTML data from a HTML resource
#define GET_WEBVIEW_AND_HTML() \
QWebView view;\
QString html = getHtml(templateResourceName);\
if (html.isEmpty())\
{\
    showErrorDialog(("Could not open file " + templateResourceName).toStdString().c_str());\
    return false;\
}

// A macro that prints the rendered HTML page into a PDF file
#define PRINT_TO_PDF() \
QPrinter printer;\
printer.setOutputFormat(QPrinter::PdfFormat);\
printer.setOutputFileName(fileName);\
view.print(&printer)

void getInvoiceReceiptAttributes(Attributes &attributes, const Job &job)
{
    // Get the customer and parts associated with the job
    Customer customer = CustomerController::getCustomer(job.getCustomerId());
    Database<Part>::recordListPtr parts = JobController::getJobParts(job.getId());

    Date jobDate(job.getDate());
    attributes["invoice-number"] =
            QString((toString(job.getId()) + toString(jobDate.day) + toString(jobDate.month) + toString(jobDate.year))
                    .c_str());

    // Fill in the date attribute and customer details attributes
    attributes["date"] = jobDate.toQStringWithoutTime();
    attributes["customer-name"] = createFullName(customer.getForename(), customer.getSurname());
    attributes["customer-addressline1"] = customer.getAddressLine1();

    if (strlen(customer.getAddressLine2()) > 0) // If there is an address line 2, then fill it in as normal
    {
        attributes["customer-addressline2"] = customer.getAddressLine2();
        attributes["customer-town"] = customer.getTown();
    }
    else // Otherwise set the town as the address line 2 to make the address look normal
    {
        attributes["customer-addressline2"] = customer.getTown();
        attributes["customer-town"] = "";
    }
    attributes["customer-postcode"] = customer.getPostcode();

    QString customerTelephone = customer.getHomePhoneNumber();
    if (strlen(customer.getMobilePhoneNumber()) > 0)
    {
        customerTelephone += " / ";
        customerTelephone += customer.getMobilePhoneNumber();
    }
    attributes["customer-telephone"] = customerTelephone;
    attributes["customer-emailaddress"] = customer.getEmailAddress();
    attributes["job-description"] = job.getDescription();

    // Loop through the parts to calculate total prices and also to generate HTML for the rows of the parts table in
    // the PDF
    double totalPartPriceExclVat = 0.0, totalPartVat = 0.0;
    QString partHtml = "";
    for (unsigned i = 0; i < parts->size(); ++i)
    {
        Part &part = parts->at(i);
        const double partPriceExclVat = part.getPrice() * part.getQuantity(),
                partVat = doubleTo2Dp(partPriceExclVat * (part.getVatRate() / 100.0));

        partHtml += "<tr><td class='text-mid'>";
        partHtml += toString(part.getQuantity()).c_str();
        partHtml += "</td><td>";
        partHtml += part.getName();
        partHtml += "</td><td class='text-mid'>";
        partHtml += L'£';
        partHtml += to2Dp(toString(partPriceExclVat).c_str());
        partHtml += "</td><td class='text-mid'>";
        partHtml += L'£';
        partHtml += to2Dp(toString(partPriceExclVat + partVat).c_str());
        partHtml += "</td></tr>";

        totalPartPriceExclVat += partPriceExclVat;
        totalPartVat += partVat;
    }
    attributes["parts-rows"] = partHtml;

    // Set the price attributes
    attributes["parts-totalpriceexclvat"] = to2Dp(toString(totalPartPriceExclVat).c_str());
    attributes["parts-vat"] = to2Dp(toString(totalPartVat).c_str());
    attributes["parts-totalpriceinclvat"] = to2Dp(toString(totalPartPriceExclVat + totalPartVat).c_str());
    attributes["job-labourcharge"] = to2Dp(toString(job.getLabourCharge()).c_str());
    attributes["vatrate"] = toString(Globals::vatRate(job.getDate())).c_str();
    attributes["job-vat"] = to2Dp(toString(job.getVat()).c_str());
    attributes["job-total"] = to2Dp(toString(job.getLabourCharge() + job.getVat()).c_str());
    attributes["totalprice-exclvat"] = to2Dp(toString(job.getLabourCharge() + totalPartPriceExclVat).c_str());
    attributes["totalprice-inclvat"]
            = to2Dp(toString(job.getLabourCharge() + job.getVat() + totalPartPriceExclVat + totalPartVat).c_str());
}

bool PdfGenerator::generateInvoice(const char *fileName_, const Job &job)
{
    QString fileName = toValidFileName(fileName_), templateResourceName = "invoice_receipt_template.html";

    Attributes attributes;
    getInvoiceReceiptAttributes(attributes, job);
    attributes["title"] = "INVOICE";

    attributes["extracontent"] =
            "<p>Cheque Payments to 'Ian Foster Services' address above. For Credit/Debit Card payments please contact "
            "Ian on number above.<br/>For Bacs payments; Sort Code 089250. Account No 70772614, Reference, your name."
            "<br/>We thank you for your custom.</p>";

    GET_WEBVIEW_AND_HTML();
    parseHtml(html, attributes);
    view.setHtml(html);
    PRINT_TO_PDF();

    return true;
}

bool PdfGenerator::generateReceipt(const char *fileName_, const Job &job)
{
    QString fileName = toValidFileName(fileName_), templateResourceName = "invoice_receipt_template.html";

    Attributes attributes;
    getInvoiceReceiptAttributes(attributes, job);
    attributes["title"] = "RECEIPT";
    // Need to update the date to the current date instead of the job date
    attributes["date"] = Date(time(NULL)).toQStringWithoutTime();

    // An extra row in the totals table in the invoice needs to be added to display the payment method
    QString extraTotalRow = "<td class='tbl-l'><strong>Payment Method:</strong></td><td class='tbl-r'>";
    extraTotalRow += job.getPaymentMethodString().c_str();
    extraTotalRow += "</td>";
    attributes["extratotalrows"] = extraTotalRow;

    GET_WEBVIEW_AND_HTML();
    parseHtml(html, attributes);
    view.setHtml(html);
    PRINT_TO_PDF();

    return true;
}

// Functions to be used in sorting/searching functions in PdfGenerator::generateReport
namespace DateFunctions
{
    static time_t dateLowerBound, dateUpperBound;

    template<typename T>
    static bool isRecordDateWithinBounds(const T &record, void *)
    {
        return (record.getDate() >= dateLowerBound) && (record.getDate() <= dateUpperBound);
    }

    template<typename T>
    static bool isRecordPaymentDateWithinBounds(const T &record, void *)
    {
        return (record.getPaymentDate() >= dateLowerBound) && (record.getPaymentDate() <= dateUpperBound);
    }

    template<typename T>
    static int compareRecordDates(const T &record1, const T &record2)
    {
        const time_t date1 = record1.getDate(), date2 = record2.getDate();
        return date1 < date2 ? -1 : (date1 > date2 ? 1 : 0);
    }
}

bool PdfGenerator::generateReport(const char *fileName, const int month, const int year)
{
    // Convert the month and year into a start date and end date, and overload PdfGenerator::generateReport to keep the
    // code DRY
    return generateReport(fileName, Date(0, 0, 1, month, year), Date(time_t(Date(0, 0, 1, month + 1, year)) - 1));
}

bool PdfGenerator::generateReport(const char *fileName_, const Date &startDate, const Date &endDate)
{
    QString fileName = toValidFileName(fileName_), templateResourceName = "report_template.html";

    // Set the date bounds, get all of the jobs and expenses and remove any that are outside the date bounds.
    // Then sort them by date ascending
    DateFunctions::dateLowerBound = startDate;
    DateFunctions::dateUpperBound = endDate;

    Database<Job>::recordListPtr jobs = JobController::getAllJobs();
    Databases::jobs().keepRecords(*jobs, DateFunctions::isRecordPaymentDateWithinBounds, NULL);
    Databases::jobs().sortRecords(*jobs, 0, jobs->size() - 1, DateFunctions::compareRecordDates);

    Database<Expense>::recordListPtr expenses = ExpenseController::getAllExpenses();
    Databases::expenses().keepRecords(*expenses, DateFunctions::isRecordDateWithinBounds, NULL);
    Databases::expenses().sortRecords(*expenses, 0, expenses->size() - 1, DateFunctions::compareRecordDates);

    // Loop through the jobs to calculate the total income excluding VAT and total VAT to be added, as well as
    // generating HTML to populate the jobs table in the report
    double incomeExclVat = 0.0, incomeVat = 0.0;
    QString jobHtml = "";
    for (unsigned i = 0; i < jobs->size(); ++i)
    {
        Job &job = jobs->at(i);
        if (job.getCompletionState() == Job::DONE_PAID)
        {
            double jobChargeExclVat = job.getLabourCharge(), jobVat = job.getVat();

            // Add part prices onto job totals
            Database<Part>::recordListPtr parts = JobController::getJobParts(job.getId());
            for (unsigned j = 0; j < parts->size(); ++j)
            {
                Part &part = parts->at(j);
                jobChargeExclVat += part.getPrice() * part.getQuantity();
                jobVat += doubleTo2Dp((part.getPrice()  * part.getQuantity()) * (part.getVatRate() / 100.0));
            }

            incomeExclVat += jobChargeExclVat;
            incomeVat += jobVat;

            // We need the customer name associated with the job
            Customer customer = CustomerController::getCustomer(job.getCustomerId());

            jobHtml += "<tr><td class='text-mid'>";
            jobHtml += Date(job.getPaymentDate()).toQStringWithoutTime();
            jobHtml += "</td><td class='text-mid'>";
            jobHtml += createFullName(customer.getForename(), customer.getSurname());
            jobHtml += "</td><td class='text-mid'>";
            jobHtml += job.getPaymentMethodString().c_str();
            jobHtml += "</td><td class='text-mid'>";
            jobHtml += L'£';
            jobHtml += to2Dp(toString(jobChargeExclVat).c_str());
            jobHtml += "</td><td class='text-mid'>";
            jobHtml += L'£';
            jobHtml += to2Dp(toString(jobVat).c_str());
            jobHtml += "</td><td class='text-mid'>";
            jobHtml += L'£';
            jobHtml += to2Dp(toString(jobChargeExclVat + jobVat).c_str());
            jobHtml += "</td></tr>";
        }
    }
    const double incomeTotal = incomeExclVat + incomeVat;

    // Loop throught the expenses to calculate totals and generate HTML
    double expensesExclVat = 0.0, expensesVat = 0.0;
    QString expenseHtml = "";
    for (unsigned i = 0; i < expenses->size(); ++i)
    {
        Expense &expense = expenses->at(i);
        expensesExclVat += expense.getPrice();
        expensesVat += expense.getVat();

        expenseHtml += "<tr><td class='text-mid'>";
        expenseHtml += Date(expense.getDate()).toQStringWithoutTime();
        expenseHtml += "</td><td class='text-mid'>";
        expenseHtml += expense.getTypeString().c_str();
        expenseHtml += "</td><td class='text-mid'>";
        expenseHtml += L'£';
        expenseHtml += to2Dp(toString(expense.getPrice()).c_str());
        expenseHtml += "</td><td class='text-mid'>";
        expenseHtml += L'£';
        expenseHtml += to2Dp(toString(expense.getVat()).c_str());
        expenseHtml += "</td><td class='text-mid'>";
        expenseHtml += L'£';
        expenseHtml += to2Dp(toString(expense.getTotalPrice()).c_str());
        expenseHtml += "</td></tr>";
    }
    const double expenseTotal = expensesExclVat + expensesVat,
            vatOwed = incomeVat - expensesVat;

    Attributes attributes;

    // Create a title that looks natural whatever start and end date is picked
    attributes["title"] = "Report for ";
    // If the start date is at the beginning of a month and the end date at the end of a month...
    if ((startDate.day == 1) && (endDate.day == (unsigned)QDate(endDate).daysInMonth()))
    {
        // If the start and end date are in the same month, use a '<month name> <year>' format
        // E.g. 'Report for March 2012'
        if ((startDate.month == endDate.month) && (startDate.year == endDate.year))
        {
            attributes["title"]
                    += QDate::longMonthName(startDate.month) + ' ' + toString(startDate.year).c_str();
        }
        // Otherwise if the years are the same, use a '<month name> - <month name> <year>' format
        // E.g. 'Report for March - June 2012'
        else if (startDate.year == endDate.year)
        {
            attributes["title"]
                    += QDate::longMonthName(startDate.month) + " - " + QDate::longMonthName(endDate.month) + ' '
                    + toString(startDate.year).c_str();
        }
        // Otherwise use a '<month name> <year> - <month name> <year>' format
        // E.g. 'Report for March 2012 - June 2013'
        else
        {
            attributes["title"]
                    += QDate::longMonthName(startDate.month) + ' ' + toString(startDate.year).c_str() + " - "
                    + QDate::longMonthName(endDate.month) + ' ' + toString(endDate.year).c_str();
        }
    }
    // Otherwise use a 'DD/MM/YYYY to DD/MM/YYYY' format, e.g. 'Report for 2/3/2012 to 17/11/2012'
    else attributes["title"] += startDate.toQStringWithoutTime() + " to " + endDate.toQStringWithoutTime();

    // Set the remaining attributes and generate the PDF
    attributes["income-exclvat"] = to2Dp(toString(incomeExclVat).c_str());
    attributes["income-vat"] = to2Dp(toString(incomeVat).c_str());
    attributes["income-total"] = to2Dp(toString(incomeTotal).c_str());
    attributes["expenses-exclvat"] = to2Dp(toString(expensesExclVat).c_str());
    attributes["expenses-vat"] = to2Dp(toString(expensesVat).c_str());
    attributes["expenses-total"] = to2Dp(toString(expenseTotal).c_str());
    attributes["profit-exclvat"] = to2Dp(toString(incomeExclVat - expensesExclVat).c_str());
    attributes["profit-inclvat"] = to2Dp(toString(incomeTotal - expenseTotal).c_str());
    attributes["vatowed"] = to2Dp(toString(vatOwed).c_str());
    attributes["jobs-rows"] = jobHtml;
    attributes["expenses-rows"] = expenseHtml;

    GET_WEBVIEW_AND_HTML();
    parseHtml(html, attributes);
    view.setHtml(html);
    PRINT_TO_PDF();

    return true;
}