Bump version and update Changes
[gruntmaster-data.git] / lib / Gruntmaster / Data.pm
index 7b6807959ec522affbcbc156f48f0a92292159d7..530aba7f80e2fb5142fde000d1a8dd2eaf4aaea3 100644 (file)
@@ -3,8 +3,9 @@ use 5.014;
 use warnings;
 
 use parent qw/Exporter/;
-our $VERSION = '5999.000_013';
-our @EXPORT = qw/purge db user_list user_entry problem_list problem_entry contest_list contest_entry contest_full contest_has_problem job_list job_entry job_full create_job standings update_status rerun_job/; ## no critic (ProhibitAutomaticExportation)
+our $VERSION = '5999.000_014';
+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/;
 use HTTP::Tiny;
@@ -27,32 +28,29 @@ my %statements = (
 
        contest_list_sth => 'SELECT * FROM contest_entry',
        contest_entry_sth => 'SELECT * FROM contest_entry WHERE id = ?',
-       contest_full_sth => 'SELECT * FROM contests WHERE id = ?',
-       contest_problems_sth => 'SELECT problem FROM contest_problems JOIN problems pb ON problem=pb.id WHERE contest = ? ORDER BY pb.value',
        contest_has_problem_sth => 'SELECT EXISTS(SELECT 1 FROM contest_problems WHERE contest = ? AND problem = ?)',
        opens_sth => 'SELECT problem,owner,time FROM opens WHERE contest = ?',
 
        problem_entry_sth => 'SELECT ' . (join ',', @{PROBLEM_PUBLIC_COLUMNS()}, 'statement', 'solution') . ' FROM problems WHERE id = ?',
        limits_sth => 'SELECT format,timeout FROM limits WHERE problem = ?',
-       problem_values_sth => 'SELECT id,value FROM problems',
 
        job_entry_sth => 'SELECT * FROM job_entry WHERE id = ?',
-       job_full_sth => 'SELECT * FROM jobs WHERE id = ?',
 
        rerun_job_sth => 'UPDATE jobs SET daemon=NULL,result=-2,result_text=NULL,results=NULL,errors=NULL WHERE id = ?',
+       take_job_sth => 'UPDATE jobs SET daemon=? WHERE id = (SELECT id FROM jobs WHERE daemon IS NULL LIMIT 1 FOR UPDATE) RETURNING id',
 );
 
 our $db;
 sub db () { $db }
 
-sub init {
+sub dbinit {
        $db = DBIx::Simple->new(@_);
        $db->keep_statements = 100;
 };
 
 sub purge;
 
-sub query {
+sub _query {
        my ($stat, @extra) = @_;
        $db->query($statements{$stat}, @extra)
 }
@@ -60,7 +58,7 @@ sub query {
 my (%name_cache, %name_cache_time);
 use constant NAME_CACHE_MAX_AGE => 5;
 
-sub object_name {
+sub _object_name {
        my ($table, $id) = @_;
        $name_cache_time{$table} //= 0;
        if (time - $name_cache_time{$table} > NAME_CACHE_MAX_AGE) {
@@ -73,28 +71,28 @@ sub object_name {
 }
 
 
-sub add_names ($) { ## no critic (ProhibitSubroutinePrototypes)
+sub _add_names ($) { ## no critic (ProhibitSubroutinePrototypes)
        my ($el) = @_;
        return unless defined $el;
        if (ref $el eq 'ARRAY') {
-               &add_names ($_) for @$el ## no critic (ProhibitAmpersandSigils)
+               &_add_names ($_) for @$el ## no critic (ProhibitAmpersandSigils)
        } else {
                for my $object (qw/contest owner problem/) {
                        my $table = $object eq 'owner' ? 'users' : "${object}s";
-                       $el->{"${object}_name"} = object_name $table, $el->{$object} if defined $el->{$object}
+                       $el->{"${object}_name"} = _object_name $table, $el->{$object} if defined $el->{$object}
                }
        }
 
        $el
 }
 
-sub user_list { +{us => scalar query('user_list_sth')->hashes} }
+sub user_list { scalar _query('user_list_sth')->hashes }
 
 sub user_entry {
        my ($id) = @_;
-       my $ret = query('user_entry_sth', $id)->hash;
-       $ret->{problems} = add_names query('problem_status_sth', $id)->hashes;
-       $ret->{contests} = add_names query('contest_status_sth', $id)->hashes;
+       my $ret = _query('user_entry_sth', $id)->hash;
+       $ret->{problems} = _add_names _query('problem_status_sth', $id)->hashes;
+       $ret->{contests} = _add_names _query('contest_status_sth', $id)->hashes;
 
        $ret;
 }
@@ -109,21 +107,14 @@ sub problem_list {
        $where{owner} = $args{owner} if $args{owner};
 
        my $table = $args{contest} ? 'problems JOIN contest_problems cp ON cp.problem = id' : 'problems';
-       my $ret = add_names $db->select(\$table, \@columns, \%where, 'name')->hashes;
-
-       my %params;
-       for (@$ret) {
-               $params{$_->{level}} //= [];
-               push @{$params{$_->{level}}}, $_
-       }
-       \%params
+       _add_names $db->select(\$table, \@columns, \%where, 'name')->hashes
 }
 
 sub problem_entry {
        my ($id, $contest) = @_;
        $contest = contest_entry ($contest) if $contest;
-       my $ret = add_names query(problem_entry_sth => $id)->hash;
-       my $limits = query(limits_sth => $id)->hashes;
+       my $ret = _add_names _query(problem_entry_sth => $id)->hash;
+       my $limits = _query(limits_sth => $id)->hashes;
        $ret->{limits} = $limits if @$limits;
 
        if ($contest) {
@@ -135,37 +126,15 @@ sub problem_entry {
        $ret
 }
 
-sub contest_list {
-       my $ret = add_names query('contest_list_sth')->hashes;
-
-       my %ret;
-       for (@$ret) {
-               my $state = $_->{finished} ? 'finished' : $_->{started} ? 'running' : 'pending';
-               $ret{$state} //= [];
-               push @{$ret{$state}}, $_;
-       }
-
-       \%ret
-}
-
-sub contest_entry {
-       my ($id) = @_;
-       add_names query(contest_entry_sth => $id)->hash;
-}
+sub contest_list { _add_names _query('contest_list_sth')->hashes }
 
-sub contest_full {
-       my ($id) = @_;
-       scalar query(contest_full_sth => $id)->hash;
-}
+sub contest_entry { _add_names _query(contest_entry_sth => $_[0])->hash }
 
-sub contest_has_problem {
-       my ($contest, $problem) = @_;
-       query('contest_has_problem_sth', $contest, $problem)->flat
-}
+sub contest_has_problem { _query('contest_has_problem_sth', @_[0, 1])->flat }
 
 sub job_list {
        my (%args) = @_;
-       $args{page} //= 1;
+       $args{page} = int ($args{page} // 1);
        my %where = (
                maybe contest => $args{contest},
                maybe owner => $args{owner},
@@ -177,38 +146,30 @@ sub job_list {
        my $rows = $db->select('job_entry', 'COUNT(*)', \%where)->list;
        my $pages = int (($rows + JOBS_PER_PAGE - 1) / JOBS_PER_PAGE);
        my ($stmt, @bind) = $db->abstract->select('job_entry', '*', \%where, {-desc => 'id'});
-       my $jobs = $db->query("$stmt LIMIT " . JOBS_PER_PAGE . ' OFFSET ' . ($args{page} - 1) * JOBS_PER_PAGE, @bind)->hashes;
-       my %ret = (
-               log => add_names $jobs,
+       my $jobs = _add_names $db->query("$stmt LIMIT " . JOBS_PER_PAGE . ' OFFSET ' . ($args{page} - 1) * JOBS_PER_PAGE, @bind)->hashes;
+       my $pageinfo = {
                current_page => $args{page},
                last_page    => $pages,
-       );
-       $ret{previous_page} = $args{page} - 1 if $args{page} - 1;
-       $ret{next_page} = $args{page} + 1 if $args{page} < $pages;
-
-       \%ret;
+               ($args{page} - 1) ? (previous_page => $args{page} - 1) : (),
+               ($args{page} < $pages) ? (next_page => $args{page} + 1) : (),
+       };
+       wantarray ? ($jobs, $pageinfo) : $jobs;
 }
 
 sub job_entry {
-       my ($id) = @_;
-       my $ret = add_names query(job_entry_sth => $id)->hash;
+       my $ret = _add_names _query(job_entry_sth => $_[0])->hash;
        $ret->{results} = decode_json $ret->{results} if $ret->{results};
        $ret
 }
 
-sub job_full {
-       my ($id) = @_;
-       scalar query(job_full_sth => $id)->hash
-}
-
 sub create_job {
        my (%args) = @_;
-       $db->update('users', {lastjob => time});
+       $db->update('users', {lastjob => time}, {id => $args{owner}});
        purge '/log/';
        scalar $db->insert('jobs', \%args, {returning => 'id'})->list
 }
 
-sub calc_score {
+sub _calc_score {
        my ($mxscore, $time, $tries, $totaltime) = @_;
        my $score = $mxscore;
        $time = 300 if $time > $totaltime; # uncoverable branch true does not happen anymore (only possible if opens are broken)
@@ -220,14 +181,12 @@ sub calc_score {
 
 sub standings {
        my ($ct) = @_;
+       my @problems = sort { $a->{value} <=> $b->{value} } @{problem_list contest => $ct};
+       my %values = map { $_->{id} => $_->{value} } @problems;
        $ct = contest_entry $ct;
 
-       my @problems = query(contest_problems_sth => $ct->{id})->flat;
-       my $pblist = problem_list;
-       my %values = query('problem_values_sth')->map;
-
        my (%scores, %tries, %opens);
-       my $opens = query(opens_sth => $ct->{id});
+       my $opens = _query(opens_sth => $ct->{id});
        while ($opens->into(my ($problem, $owner, $time))) {
                $opens{$problem, $owner} = $time;
        }
@@ -241,25 +200,23 @@ sub standings {
                my $value = $values{$job->{problem}};
                my $factor = $job->{result} ? 0 : 1;
                $factor = $1 / 100 if $job->{result_text} =~ /^(\d+ )/s;
-               $scores{$job->{owner}}{$job->{problem}} = int ($factor * calc_score ($value, $time, $tries{$job->{owner}}{$job->{problem}}++, $ct->{stop} - $ct->{start}));
+               $scores{$job->{owner}}{$job->{problem}} = int ($factor * _calc_score ($value, $time, $tries{$job->{owner}}{$job->{problem}}++, $ct->{stop} - $ct->{start}));
        }
 
        my @st = sort { $b->{score} <=> $a->{score} or $a->{user} cmp $b->{user} } map { ## no critic (ProhibitReverseSortBlock)
                my $user = $_;
                +{
                        user => $user,
-                       user_name => object_name(users => $user),
+                       user_name => _object_name(users => $user),
                        score => sum (values %{$scores{$user}}),
-                       scores => [map { $scores{$user}{$_} // '-'} @problems],
+                       scores => [map { $scores{$user}{$_->{id}} // '-'} @problems],
                }
        } keys %scores;
 
        $st[0]->{rank} = 1 if @st;
        $st[$_]->{rank} = $st[$_ - 1]->{rank} + ($st[$_]->{score} < $st[$_ - 1]->{score}) for 1 .. $#st;
-       +{
-               st => \@st,
-               problems => [map { [ $_, object_name(problems => $_)] } @problems],
-       }
+
+       \@st
 }
 
 sub update_status {
@@ -274,7 +231,7 @@ sub update_status {
 
        my @contest_statuses = map {
                my $ct = $_;
-               map { [$ct, $_->{user}, $_->{score}, $_->{rank}] } @{standings($ct)->{st}}
+               map { [$ct, $_->{user}, $_->{score}, $_->{rank}] } @{standings $ct}
        } $db->select('contests', 'id')->flat;
 
        $db->begin;
@@ -287,11 +244,49 @@ sub update_status {
 
 sub rerun_job {
        my ($id) = @_;
-       $db->query(rerun_job_sth => $id);
+       _query rerun_job_sth => $id;
        purge '/log/';
        purge "/log/$id";
 }
 
+sub take_job {
+       my ($daemon) = @_;
+       my $id = _query(take_job_sth => $daemon)->list;
+       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},
+               owner   => $job->{owner},
+               job     => $job->{id},
+               solved  => ($args{result} ? 0 : 1),
+       };
+       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} : ();
 my $ht = HTTP::Tiny->new;
 
@@ -311,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) >>
+=over
 
-=item problem($id)
+=item owner
 
-Equivalent to C<< $schema->resultset('Problem')->find($id) >>
+Only show problems owned by this user
 
-=item user($id)
+=item contest
 
-Equivalent to C<< $schema->resultset('User')->find($id) >>
+Only show problems in this contest
 
-=item user_list
+=item private
 
-Returns a list of users as an arrayref containing hashrefs.
+If true, include private problems. Always true if contest is present.
 
-=item user_entry($id)
+=item solution
 
-Returns a hashref with information about the user $id.
+If true, include problem solutions
 
-=item problem_list([%args])
+=back
 
-Returns a list of problems grouped by level. A hashref with levels as keys.
+=item B<problem_entry>(i<$id>, [I<$contest>])
 
-Takes the following arguments:
+Returns a hashref describing the problem I<$id>. If $contest is
+present, contest start and stop times are included, and the solution
+is deleted.
 
-=over
+=item B<contest_list>
 
-=item owner
+Returns an arrayref of contests.
 
-Only show problems owned by this user
-
-=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
+
+Show this page of the job log. Defaults to 1.
 
-An arrayref of hashrefs representing pending contests
+=item owner
 
-=item running
+Only show jobs submitted by this user.
 
-An arrayref of hashrefs representing running contests
+=item contest
 
-=item finished
+Only show jobs submitted in this contest.
 
-An arrayref of hashrefs representing finished contests
+=item problem
 
-=back
+Only show jobs submitted for this problem.
 
-Takes the following arguments:
+=item result
 
-=over
+Only show jobs with this result (see the constants in
+L<Gruntmaster::Daemon::Constants>).
 
-=item owner
+=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
 
@@ -481,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.021651 seconds and 4 git commands to generate.