From a4e3c35a193a717144df03eee729f8ba705099eb Mon Sep 17 00:00:00 2001 From: Nicolas Vigier Date: Thu, 6 Jun 2013 16:58:47 +0000 Subject: First version --- .gitignore | 1 + COPYING | 121 +++++++++++++++++++++++++++++++++++++++++++++ NEWS | 2 + README | 2 + config_default | 10 ++++ mkadvisories | 144 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ tmpl/advisory.txt | 29 +++++++++++ tmpl/report.txt | 9 ++++ 8 files changed, 318 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 mkadvisories create mode 100644 tmpl/advisory.txt create mode 100644 tmpl/report.txt 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..4983ee3 --- /dev/null +++ b/NEWS @@ -0,0 +1,2 @@ +- first version + diff --git a/README b/README new file mode 100644 index 0000000..436556a --- /dev/null +++ b/README @@ -0,0 +1,2 @@ +mga-advisories is a tool to manage an advisories database. + diff --git a/config_default b/config_default new file mode 100644 index 0000000..b67b9c0 --- /dev/null +++ b/config_default @@ -0,0 +1,10 @@ +advisories_dir: /var/lib/mga-advisories/advisories +status_dir: /var/lib/mga-advisories/status +tmpl_dir: /usr/share/mga-advisories/tmpl +output_format: + - txt +out_dir: /var/lib/mga-advisories/out +adv_mail_to: updates-announce@ml.mageia.org +adv_mail_from: Mageia Updates +report_mail_to: qa-reports@ml.mageia.org +report_mail_from: Mageia Advisories diff --git a/mkadvisories b/mkadvisories new file mode 100755 index 0000000..ac229a2 --- /dev/null +++ b/mkadvisories @@ -0,0 +1,144 @@ +#!/usr/bin/perl -w + +use strict; + +use YAML qw(LoadFile DumpFile); +use Template; +use DateTime; +use Email::Sender::Simple qw(try_to_sendmail); +use Email::Simple; +use Email::Simple::Creator; +#use Data::Dump qw(dd); + +my $config_file = '/usr/share/mga-advisories/config'; +my $config = LoadFile($ENV{MGAADV_CONF} || $config_file); +my $etc_config_file = '/etc/mga-advisories.conf'; +my $etc_config = LoadFile($etc_config_file); + +my @report_logs; +sub report_log { + push @report_logs, @_; +} + +sub report_exit { + report_log($_[0]); + send_report_mail({ error => $_[0] }); + exit 1; +} + +foreach my $k (keys %$etc_config) { + $config->{$k} = $etc_config->{$k}; +} + +sub status_file { + $config->{status_dir} . '/' . $_[0]; +} + +sub save_status { + my ($advdb, $adv) = @_; + my $statusfile = status_file($adv); + DumpFile($statusfile, $advdb->{advisories}{$adv}{status}); +} + +sub get_advisories { + my %advisories; + foreach my $advfile (glob "$config->{advisories_dir}/*.adv") { + my $adv = LoadFile($advfile); + next unless $adv->{ID}; + report_exit("Duplicate advisory $adv->{ID}") if $advisories{$adv->{ID}}; + $advisories{$adv->{ID}} = $adv; + my $statusfile = status_file($adv->{ID}); + $adv->{status} = -f $statusfile ? LoadFile($statusfile) : {}; + } + return \%advisories; +} + +sub process_template { + my ($template, $src, $vars, $dest, $ext) = @_; + foreach my $extension ($ext ? $ext : @{$config->{output_format}}) { + next unless -f "$config->{tmpl_dir}/$src.$extension"; + $template->process("$src.$extension", $vars, ref $dest ? $dest : "$dest.$extension") + || die $template->error, "\n"; + } +} + +sub output_pages { + my ($advdb) = @_; + my $template = Template->new( + INCLUDE_PATH => $config->{tmpl_dir}, + OUTPUT_PATH => $config->{out_dir}, + ); + foreach my $adv (keys %{$advdb->{advisories}}) { + my $vars = { + config => $config, + advisory => $adv, + advdb => $advdb, + }; + process_template($template, 'advisory', $vars, $adv); + } +} + +sub send_adv_mail { + my ($advdb) = @_; + return unless $config->{send_adv_mail} eq 'yes'; + my $template = Template->new( + INCLUDE_PATH => $config->{tmpl_dir}, + ); + foreach my $adv (keys %{$advdb->{advisories}}) { + next if $advdb->{advisories}{$adv}{status}{mail_sent}; + my $mailcontent; + my $vars = { + config => $config, + advisory => $adv, + advdb => $advdb, + }; + process_template($template, 'advisory', $vars, \$mailcontent, 'txt'); + my $email = Email::Simple->create( + header => [ + To => $config->{adv_mail_to}, + From => $config->{adv_mail_from}, + Subject => "$adv: " . $advdb->{advisories}{$adv}{subject}, + ], + body => $mailcontent + ); + if (try_to_sendmail($email)) { + report_log("Advisory mail for $adv sent"); + $advdb->{advisories}{$adv}{status}{mail_sent} = time(); + save_status($advdb, $adv); + } else { + report_log("Error sending advisory mail $adv"); + } + } +} + +sub send_report_mail { + my ($advdb) = @_; + return unless $config->{send_report_mail} eq 'yes'; + return unless @report_logs; + my $template = Template->new( + INCLUDE_PATH => $config->{tmpl_dir}, + ); + my $mailcontent; + my $vars = { + config => $config, + advdb => $advdb, + report_logs => \@report_logs, + }; + process_template($template, 'report', $vars, \$mailcontent, 'txt'); + my $email = Email::Simple->create( + header => [ + To => $config->{report_mail_to}, + From => $config->{report_mail_from}, + Subject => $advdb->{error} ? 'Advisories Error' : 'Advisories Update', + ], + body => $mailcontent + ); + try_to_sendmail($email); +} + +my %advdb; +$advdb{advisories} = get_advisories(); +output_pages(\%advdb); +send_adv_mail(\%advdb); +send_report_mail(\%advdb); + diff --git a/tmpl/advisory.txt b/tmpl/advisory.txt new file mode 100644 index 0000000..3da22c5 --- /dev/null +++ b/tmpl/advisory.txt @@ -0,0 +1,29 @@ +[% USE date -%] +[%- SET adv = advdb.advisories.$advisory -%] +[% advisory %] - [% adv.subject %] + +Publication date: [% date.format(adv.pubtime, format => '%d %b %Y', gmt => 1) %] +Type: [% adv.type %] +Affected Mageia releases: [% adv.src.keys.sort.join(', ') %] +[% IF adv.CVE -%] +CVE: [% adv.CVE.join(",\n ") %] +[%- END -%] + + +Description: +[% adv.description -%] + +References: +[% FOREACH ref IN adv.references -%] +- [% ref %] +[% END -%] + +SRPMS: +[% FOREACH rel IN adv.src.keys -%] +[% FOREACH media IN adv.src.$rel.keys -%] +[% FOREACH srpm IN adv.src.$rel.$media -%] +- [% rel %]/[% media %]/[% srpm %] +[% END -%] +[% END -%] +[% END -%] + diff --git a/tmpl/report.txt b/tmpl/report.txt new file mode 100644 index 0000000..a1c629d --- /dev/null +++ b/tmpl/report.txt @@ -0,0 +1,9 @@ +[% IF advdb.error -%] +Error: [% advdb.error %] +[% ELSE %] +Advisories updates : +[% FOREACH report_log IN report_logs -%] +- [% report_log %] +[% END -%] +[% END -%] + -- cgit v1.2.1