From 67438a91f1f65d7de5743bfdf8455c473b75e885 Mon Sep 17 00:00:00 2001 From: Nicolas Vigier Date: Sat, 11 May 2013 09:51:05 +0000 Subject: First version git-svn-id: svn+ssh://svn.mageia.org/svn/soft/mga-treasurer/trunk@8203 5b7c3c08-40e5-403b-9995-ace06908e4af --- .gitignore | 1 + COPYING | 121 ++++++++++++++++++++++++++++++++++++++ NEWS | 3 + README | 4 ++ config_default | 6 ++ mga-treasurer | 136 +++++++++++++++++++++++++++++++++++++++++++ tmpl/donations.html | 31 ++++++++++ tmpl/donations_by_month.html | 28 +++++++++ tmpl/donations_by_year.html | 29 +++++++++ 9 files changed, 359 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 NEWS create mode 100644 README create mode 100644 config_default create mode 100755 mga-treasurer create mode 100644 tmpl/donations.html create mode 100644 tmpl/donations_by_month.html create mode 100644 tmpl/donations_by_year.html diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b25c15b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*~ diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/COPYING @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..96ce611 --- /dev/null +++ b/NEWS @@ -0,0 +1,3 @@ + +- first version + diff --git a/README b/README new file mode 100644 index 0000000..861a27e --- /dev/null +++ b/README @@ -0,0 +1,4 @@ +mga-treasurer is a script that is used to generate a website showing +informations about latest donations received and expenses for Mageia.Org +association. + diff --git a/config_default b/config_default new file mode 100644 index 0000000..2ffbd2b --- /dev/null +++ b/config_default @@ -0,0 +1,6 @@ +grisbi_file: /vra/lib/mga-treasurer/data/mga-accounts.gsb +tmpl_dir: /usr/share/mga-treasurer/tmpl +output_format: + - html +out_dir: /var/www/mga-treasurer +sitename: Mageia.Org diff --git a/mga-treasurer b/mga-treasurer new file mode 100755 index 0000000..9cec2b5 --- /dev/null +++ b/mga-treasurer @@ -0,0 +1,136 @@ +#!/usr/bin/perl -w + +use strict; + +use YAML qw/LoadFile/; +use XML::Simple; +use Template; +use DateTime; +#use Data::Dump qw/dd/; + +my $config_file = '/usr/share/mga-treasurer/config'; +my $config = LoadFile($ENV{MGATRES_CONF} ? $ENV{MGATRES_CONF} : $config_file); +my $etc_config_file = '/etc/mga-treasurer.conf'; +my $etc_config = LoadFile($etc_config_file); + +foreach my $k (keys %{$etc_config}) { + $config->{$k} = $etc_config->{$k}; +} + + +sub donation_category { + my $r = shift; + my @c = grep {$_->{Na} eq 'Donation'} @{$r->{Category}}; + return @c ? $c[0]->{Nb} : undef; +} + +sub party_name { + my ($r, $Nb) = @_; + (grep { $_->{Nb} == $Nb } @{$r->{Party}})[0]->{Na}; +} + +sub subcat_name { + my ($r, $Nb) = @_; + (grep { $_->{Nb} == $Nb } @{$r->{Sub_category}})[0]->{Na}; +} + +sub epoch_date { + my ($m, $d, $y) = split /\//, shift; + DateTime->new(day => $d, month => $m, year => $y)->epoch; +} + +sub donations_list { + my $r = shift; + my @res; + my $don_cat = donation_category($r); + my @donations = grep { $_->{Ca} == $don_cat } @{$r->{Transaction}}; + foreach my $don (@donations) { + my %d = ( + amount => $don->{Am}, + date => epoch_date($don->{Dt}), + who => party_name($r, $don->{Pa}), + type => subcat_name($r, $don->{Sca}), + $don->{No} ne '(null)' ? (notes => $don->{No}) : (), + ); + push @res, \%d; + } + return \@res; +} + +sub donations_infos { + my $r = shift; + my %res = ( + donations => donations_list($r), + by_month => {}, + by_year => {}, + total_30 => 0, + ); + foreach my $don (@{$res{donations}}) { + my $dt = DateTime->from_epoch(epoch => $don->{date}); + my $month = $dt->year . '-' . $dt->month; + my $year = $dt->year; + push @{$res{by_month}->{$month}->{donations}}, $don; + $res{by_month}->{$month}->{year} = $year; + $res{by_month}->{$month}->{month} = $dt->month; + push @{$res{by_year}->{$year}->{donations}}, $don; + push @{$res{by_year}->{$year}->{months}}, $month; + if (time - $don->{date} < '2592000') { # last 30 days + $res{total_30} += $don->{amount}; + } + } + foreach my $d ((values $res{by_month}), (values $res{by_year})) { + foreach my $don (@{$d->{donations}}) { + $d->{total} += $don->{amount}; + $d->{type}->{$don->{type}} += $don->{amount}; + } + } + return \%res; +} + +sub process_template { + my ($template, $src, $vars, $dest) = @_; + foreach my $extension (@{$config->{output_format}}) { + next unless -f "$config->{tmpl_dir}/$src.$extension"; + $template->process("$src.$extension", $vars, "$dest.$extension"); + } +} + +sub output_pages { + my ($donations) = @_; + my $template = Template->new( + INCLUDE_PATH => $config->{tmpl_dir}, + OUTPUT_PATH => $config->{out_dir}, + ); + + my $last_update = (stat $config->{grisbi_file})[9]; + foreach my $month (keys $donations->{by_month}) { + my $vars = { + config => $config, + month => $month, + donations => $donations, + }; + process_template($template, 'donations_by_month', $vars, "donations_$month"); + } + + foreach my $year (keys $donations->{by_year}) { + my $vars = { + config => $config, + year => $year, + donations => $donations, + }; + process_template($template, 'donations_by_year', $vars, "donations_$year"); + } + + my $vars = { + config => $config, + donations => $donations, + last_update => $last_update, + }; + process_template($template, 'donations', $vars, 'donations'); +} + +my $r = XMLin($config->{grisbi_file}); +my $donations = donations_infos($r); + +output_pages($donations); + diff --git a/tmpl/donations.html b/tmpl/donations.html new file mode 100644 index 0000000..aa8f80e --- /dev/null +++ b/tmpl/donations.html @@ -0,0 +1,31 @@ +[% SET login = users.$user.uid.0 %] + + + + [% config.sitename %] Donations + + + [%- USE date(format='%Y/%m/%d') -%] +

Mageia.Org donations

+ [% donations.total_30 %] Euros have been donated to Mageia.org in the last 30 days. + + [%- l = 5 -%] +

Last [% l %] donations

+ + +

Donations per year

+ + Last update: [% date.format(last_update, format => '%Y/%m/%d %H:%M:%S') %] + + diff --git a/tmpl/donations_by_month.html b/tmpl/donations_by_month.html new file mode 100644 index 0000000..9dd338d --- /dev/null +++ b/tmpl/donations_by_month.html @@ -0,0 +1,28 @@ +[% SET login = users.$user.uid.0 %] + + + + [% config.sitename %]: Donations for [% month %] + + +

Mageia.Org donations for month [% month %]

+

Summary

+ +

Donations list

+ + + diff --git a/tmpl/donations_by_year.html b/tmpl/donations_by_year.html new file mode 100644 index 0000000..e7941bb --- /dev/null +++ b/tmpl/donations_by_year.html @@ -0,0 +1,29 @@ +[% SET login = users.$user.uid.0 %] + + + + [% config.sitename %]: Donations for [% year %] + + +

Mageia.Org donations for year [% year %]

+

Summary

+ +

Donations for each month

+ + + -- cgit v1.2.1