Update README and copyright notices
[gruntmaster-data.git] / lib / Gruntmaster / Data.pm
index 8c2fb173fcb62909de6f8140c64147451278eca6..d5d7152462e1218a274c5dd1421ee3a9c56513dc 100644 (file)
@@ -4,7 +4,7 @@ use warnings;
 
 use parent qw/Exporter/;
 our $VERSION = '5999.000_013';
-our @EXPORT = qw/dbinit purge db user_list user_entry problem_list problem_entry contest_list contest_entry contest_has_problem job_list job_entry create_job standings update_status rerun_job take_job finish_job/; ## no critic (ProhibitAutomaticExportation)
+our @EXPORT = qw/dbinit purge db user_list user_entry problem_list problem_entry contest_list contest_entry contest_has_problem job_list job_entry create_job standings update_status rerun_job take_job finish_job open_problem/;
 our @EXPORT_OK = @EXPORT;
 
 use JSON::MaybeXS qw/decode_json/;
@@ -252,12 +252,17 @@ sub rerun_job {
 sub take_job {
        my ($daemon) = @_;
        my $id = _query(take_job_sth => $daemon)->list;
-       return $id ? db->select(jobs => '*', {id => $id})->hash : undef;
+       return unless $id;
+       purge '/log/';
+       purge "/log/$id";
+       db->select(jobs => '*', {id => $id})->hash
 }
 
 sub finish_job {
        my ($job, $private, %args) = @_;
        db->update(jobs => \%args, {id => $job->{id}});
+       purge '/log/';
+       purge '/log/' . $job->{id};
        return if $private;
        my $status = {
                problem => $job->{problem},
@@ -268,6 +273,18 @@ sub finish_job {
        eval {
                db->insert(problem_status => $status)
        } or db->update(problem_status => $status, {owner => $job->{owner}, problem => $job->{problem}});
+       purge '/us/' . $job->{owner};
+}
+
+sub open_problem {
+       my ($contest, $problem, $owner, $time) = @_;
+       my $ct = contest_entry($contest);
+       return unless $ct->{id} && $time >= $ct->{start} && $time < $ct->{stop}; ## no critic (ProhibitNegativeExpressionsInUnlessAndUntilConditions)
+       eval { db->insert(opens => { ## no critic (RequireCheckingReturnValueOfEval)
+               contest => $contest,
+               problem => $problem,
+               owner => $owner,
+               time => $time}) };
 }
 
 my @PURGE_HOSTS = exists $ENV{PURGE_HOSTS} ? split ' ', $ENV{PURGE_HOSTS} : ();
@@ -289,167 +306,158 @@ Gruntmaster::Data - Gruntmaster 6000 Online Judge -- database interface and tool
 
 =head1 SYNOPSIS
 
-  my $db = Gruntmaster::Data->connect('dbi:Pg:');
-
-  my $problem = $db->problem('my_problem');
-  $problem->update({timeout => 2.5}); # Set time limit to 2.5 seconds
-  $problem->rerun; # And rerun all jobs for this problem
-
-  # ...
-
-  my $contest = $db->contests->create({ # Create a new contest
-    id => 'my_contest',
-    name => 'My Awesome Contest',
-    start => time + 100,
-    end => time + 1900,
-  });
-  $db->contest_problems->create({ # Add a problem to the contest
-    contest => 'my_contest',
-    problem => 'my_problem',
-  });
-
-  say 'The contest has not started yet' if $contest->is_pending;
-
-  # ...
-
-  my @jobs = $db->jobs->search({contest => 'my_contest', owner => 'MGV'})->all;
-  $_->rerun for @jobs; # Rerun all jobs sent by MGV in my_contest
 
 =head1 DESCRIPTION
 
-Gruntmaster::Data is the interface to the Gruntmaster 6000 database. Read the L<DBIx::Class> documentation for usage information.
+Gruntmaster::Data is the interface to the Gruntmaster 6000 database.
 
-In addition to the typical DBIx::Class::Schema methods, this module contains several convenience methods:
+All functions are exported by default.
 
 =over
 
-=item contests
+=item B<dbinit>(I<@args>)
 
-Equivalent to C<< $schema->resultset('Contest') >>
+This function connects to the database. I<@args> are the arguments
+passed to the L<DBIx::Simple> constructor.
 
-=item contest_problems
+=item B<purge>(I<$url_path>)
 
-Equivalent to C<< $schema->resultset('ContestProblem') >>
+Purges a relative URL from the Varnish Cache by sending PURGE
+$url_path requests to all hosts in the PURGE_HOSTS environment
+variable.
 
-=item jobs
+=item B<db>
 
-Equivalent to C<< $schema->resultset('Job') >>
+Returns a L<DBIx::Simple> object for interacting with the database
+directly. Use this when no other function in this module is suitable.
 
-=item problems
+=item B<user_list>
 
-Equivalent to C<< $schema->resultset('Problem') >>
+Returns an arrayref of the top 200 users.
 
-=item users
+=item B<user_entry>(I<$id>)
 
-Equivalent to C<< $schema->resultset('User') >>
+Returns a hashref describing the user I<$id>.
 
-=item contest($id)
+=item B<problem_list>([I<%args>])
 
-Equivalent to C<< $schema->resultset('Contest')->find($id) >>
+Returns an arrayref of problems.
 
-=item job($id)
+Takes the following named arguments:
 
-Equivalent to C<< $schema->resultset('Job')->find($id) >>
-
-=item problem($id)
+=over
 
-Equivalent to C<< $schema->resultset('Problem')->find($id) >>
+=item owner
 
-=item user($id)
+Only show problems owned by this user
 
-Equivalent to C<< $schema->resultset('User')->find($id) >>
+=item contest
 
-=item user_list
+Only show problems in this contest
 
-Returns a list of users as an arrayref containing hashrefs.
+=item private
 
-=item user_entry($id)
+If true, include private problems. Always true if contest is present.
 
-Returns a hashref with information about the user $id.
+=item solution
 
-=item problem_list([%args])
+If true, include problem solutions
 
-Returns a list of problems grouped by level. A hashref with levels as keys.
+=back
 
-Takes the following arguments:
+=item B<problem_entry>(i<$id>, [I<$contest>])
 
-=over
+Returns a hashref describing the problem I<$id>. If $contest is
+present, contest start and stop times are included, and the solution
+is deleted.
 
-=item owner
+=item B<contest_list>
 
-Only show problems owned by this user
+Returns an arrayref of contests.
 
-=item contest
+=item B<contest_entry>(I<$id>)
 
-Only show problems in this contest
+Returns a hashref describing the contest I<$id>.
 
-=back
+=item B<contest_has_problem>(I<$contest>, I<$problem>)
 
-=item problem_entry($id, [$contest, $user])
+Returns true if the contest I<$contest> includes the problem
+I<$problem>, false otherwise.
 
-Returns a hashref with information about the problem $id. If $contest and $user are present, problem open data is updated.
+=item B<job_list>([I<%args>])
 
-=item contest_list([%args])
+In scalar context, returns an arrayref of jobs. In list context,
+returns an arrayref of jobs and a hashref of information about pages.
 
-Returns a list of contests grouped by state. A hashref with the following keys:
+Takes the following named arguments:
 
 =over
 
-=item pending
+=item page
 
-An arrayref of hashrefs representing pending contests
+Show this page of the job log. Defaults to 1.
 
-=item running
+=item owner
 
-An arrayref of hashrefs representing running contests
+Only show jobs submitted by this user.
 
-=item finished
+=item contest
 
-An arrayref of hashrefs representing finished contests
+Only show jobs submitted in this contest.
 
-=back
+=item problem
 
-Takes the following arguments:
+Only show jobs submitted for this problem.
 
-=over
+=item result
 
-=item owner
+Only show jobs with this result (see the constants in
+L<Gruntmaster::Daemon::Constants>).
+
+=item private
 
-Only show contests owned by this user.
+If true, include private jobs. Defaults to false.
 
 =back
 
-=item contest_entry($id)
+=item B<job_entry>(I<$id>)
 
-Returns a hashref with information about the contest $id.
+Returns a hashref describing the job I<$id>.
 
-=item job_list([%args])
+=item B<create_job>(I<%args>)
 
-Returns a list of jobs as an arrayref containing hashrefs. Takes the following arguments:
+Insert a new job into the database. This function also updates the
+lastjob field for the job's owner.
 
-=over
+=item B<standings>(I<$ct>)
 
-=item owner
+Returns an arrayref of the standings of contest I<$ct>.
 
-Only show jobs submitted by this user.
+=item B<update_status>
 
-=item contest
+Rebuilds the problem_status and contest_status tables.
 
-Only show jobs submitted in this contest.
+=item B<rerun_job>(I<$id>)
 
-=item problem
+Marks the job $id as pending and clears its results, so that it will
+be run again by the daemon.
 
-Only show jobs submitted for this problem.
+=item B<take_job>(I<$daemon>)
 
-=item page
+Marks a random job as being run by I<$daemon>. Returns a hashref
+describing the job, or undef if no job was available.
 
-Show this page of results. Defaults to 1. Pages have 10 entries, and the first page has the most recent jobs.
+=item B<finish_job>(I<$job>, I<$private>, I<%results>)
 
-=back
+Updates the job $job with the results in %results. If $private is
+false, also updates the problem_status table.
 
-=item job_entry($id)
+=item B<open_problem>(I<$contest>, I<$problem>, I<$owner>, I<$time>)
 
-Returns a hashref with information about the job $id.
+Notes that I<$owner> has opened the problem I<$problem> of contest
+I<$contest> at time I<$time>. If the C<opens> table already contains
+this (I<$contest>, I<$problem>, I<$owner>) triplet, this function does
+nothing.
 
 =back
 
@@ -459,10 +467,10 @@ Marius Gavrilescu E<lt>marius@ieval.roE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright (C) 2014 by Marius Gavrilescu
+Copyright (C) 2014-2015 by Marius Gavrilescu
 
 This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself, either Perl version 5.18.1 or,
+it under the same terms as Perl itself, either Perl version 5.20.1 or,
 at your option, any later version of Perl 5 you may have available.
 
 
This page took 0.01695 seconds and 4 git commands to generate.