Update README and copyright notices
[gruntmaster-data.git] / lib / Gruntmaster / Data.pm
index da9d944c5e8c5e799f34ec140d75dc61118748bb..d5d7152462e1218a274c5dd1421ee3a9c56513dc 100644 (file)
 package Gruntmaster::Data;
-use v5.14;
+use 5.014;
 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 open_problem/;
+our @EXPORT_OK = @EXPORT;
 
-use JSON qw/encode_json decode_json/;
-use Redis;
-use Sub::Name qw/subname/;
+use JSON::MaybeXS qw/decode_json/;
+use HTTP::Tiny;
+use PerlX::Maybe qw/maybe/;
 
-our $VERSION = '5999.000_002';
+use DBI;
+use DBIx::Simple;
+use List::Util qw/sum/;
+use SQL::Abstract;
 
-our $contest;
-my $redis = Redis->new;
-my $pubsub = Redis->new;
+use constant PROBLEM_PUBLIC_COLUMNS => [qw/id author writer level name owner private timeout olimit value/];
+use constant JOBS_PER_PAGE => 50;
 
-sub dynsub{
-       our ($name, $sub) = @_;
-       no strict 'refs';
-       *$name = subname $name => $sub
-}
+my %statements = (
+       user_list_sth => 'SELECT * FROM user_list LIMIT 200',
+       user_entry_sth => 'SELECT * FROM user_data WHERE id = ?',
 
-BEGIN {
-       for my $cmd (qw/multi exec smembers get hget hgetall hdel hset sadd srem incr hmset hsetnx publish del/) {
-               dynsub uc $cmd, sub { $redis->$cmd(@_) };
-       }
+       problem_status_sth => 'SELECT problem,solved FROM problem_status WHERE owner = ?',
+       contest_status_sth => 'SELECT contest,score,rank FROM contest_status WHERE owner = ?',
 
-       for my $cmd (qw/subscribe wait_for_messages/) {
-               dynsub uc $cmd, sub { $pubsub->$cmd(@_) };
-       }
-}
+       contest_list_sth => 'SELECT * FROM contest_entry',
+       contest_entry_sth => 'SELECT * FROM contest_entry WHERE id = ?',
+       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 = ?',
 
-sub cp { defined $contest ? "contest.$contest." : '' }
-
-sub problems                   ()              { SMEMBERS cp . 'problem' }
-sub contests                   ()              { SMEMBERS cp . 'contest' }
-sub users                              ()              { SMEMBERS cp . 'user' }
-sub jobcard                            ()              { GET cp . 'job' }
-
-sub job_results                        (_)             { decode_json HGET cp . "job.$_[0]", 'results' }
-sub set_job_results            ($+)    { HSET cp . "job.$_[0]", 'results', encode_json $_[1] }
-sub job_inmeta                 (_)             { decode_json HGET cp . "job.$_[0]", 'inmeta' }
-sub set_job_inmeta             ($+)    { HSET cp . "job.$_[0]", 'inmeta', encode_json $_[1] }
-sub problem_meta               (_)             { decode_json HGET cp . "problem.$_[0]", 'meta' }
-sub set_problem_meta   ($+)    { HSET cp . "problem.$_[0]", 'meta', encode_json $_[1] }
-sub job_daemon                 (_)             { HGET cp . "job.$_[0]", 'daemon' }
-sub set_job_daemon             ($$)    { HSETNX cp . "job.$_[0]", 'daemon', $_[1] };
-
-sub defhash{
-       my ($name, @keys) = @_;
-       for my $key (@keys) {
-               dynsub "${name}_$key", sub (_)  { HGET cp . "$name.$_[0]", $key };
-               dynsub "set_${name}_$key", sub ($$) { HSET cp . "$name.$_[0]", $key, $_[1] };
-       }
+       problem_entry_sth => 'SELECT ' . (join ',', @{PROBLEM_PUBLIC_COLUMNS()}, 'statement', 'solution') . ' FROM problems WHERE id = ?',
+       limits_sth => 'SELECT format,timeout FROM limits WHERE problem = ?',
 
-       dynsub "edit_$name", sub {
-               my ($key, %values) = @_;
-               HMSET cp . "$name.$key", %values;
-       };
+       job_entry_sth => 'SELECT * FROM job_entry WHERE id = ?',
 
-       dynsub "insert_$name", sub {
-               my ($key, %values) = @_;
-               SADD cp . $name, $key or return;
-               HMSET cp . "$name.$key", %values;
-       };
-       dynsub "remove_$name", sub (_) {
-               my $key = shift;
-               SREM cp . $name, $key;
-               DEL cp . "$name.$key";
-       };
+       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',
+);
 
-       dynsub "push_$name", sub {
-               my $nr = INCR cp . $name;
-               HMSET cp . "$name.$nr", @_;
-               $nr
-       };
-}
+our $db;
+sub db () { $db }
 
-defhash problem => qw/name level difficulty statement owner author private generator runner judge testcnt timeout olimit/;
-defhash contest => qw/start end name owner/;
-defhash job => qw/date errors extension filesize private problem result result_text user/;
-defhash user => qw/name email lastjob town university level/;
-
-sub clean_job (_){
-       HDEL cp . "job.$_[0]", qw/result result_text results daemon/
-}
-
-sub mark_open {
-       my ($problem, $user) = @_;
-       HSETNX cp . 'open', "$problem.$user", time;
-}
-
-sub get_open {
-       my ($problem, $user) = @_;
-       HGET cp . 'open', "$problem.$user";
-}
-
-our @EXPORT = do {
-       no strict 'refs';
-       grep { $_ =~ /^[a-zA-Z]/ and exists &$_ } keys %{__PACKAGE__ . '::'};
+sub dbinit {
+       $db = DBIx::Simple->new(@_);
+       $db->keep_statements = 100;
 };
 
-1;
-__END__
-
-=encoding utf-8
-
-=head1 NAME
-
-Gruntmaster::Data - Gruntmaster 6000 Online Judge -- database interface and tools
-
-=head1 SYNOPSIS
-
-  for my $problem (problems) {
-    say "Problem name: " . problem_name $problem;
-    say "Problem level: " . problem_level $problem;
-    ...
-  }
-
-=head1 DESCRIPTION
-
-Gruntmaster::Data is the Redis interface used by the Gruntmaster 6000 Online Judge. It exports many functions for talking to the database. All functions are exported by default.
-
-The current contest is selected by setting the C<< $Gruntmaster::Data::contest >> variable.
-
-  local $Gruntmaster::Data::contest = 'mycontest';
-  say 'There are' . jobcard . ' jobs in my contest';
-
-=head1 FUNCTIONS
-
-=head2 Redis
-
-Gruntmaster::Data exports some functions for talking directly to the Redis server. These functions should not normally be used, except for B<MULTI>, B<EXEC>, B<PUBLISH>, B<SUBSCRIBE> and B<WAIT_FOR_MESSAGES>.
-
-These functions correspond to Redis commands. The current list is: B<< MULTI EXEC SMEMBERS GET HGET HGETALL HDEL HSET SADD SREM INCR HMSET HSETNX DEL PUBLISH SUBSCRIBE WAIT_FOR_MESSAGES >>.
-
-=head2 Problems
-
-=over
+sub purge;
 
-=item B<problems>
-
-Returns a list of problems in the current contest.
-
-=item B<problem_meta> I<$problem>
-
-Returns a problem's meta.
-
-=item B<set_problem_meta> I<$problem>, I<$meta>
-
-Sets a problem's meta.
-
-=item B<problem_name> I<$problem>
-
-Returns a problem's name.
-
-=item B<set_problem_name> I<$problem>, I<$name>
-
-Sets a problem's name.
-
-=item B<problem_level> I<$problem>
-
-Returns a problem's level. The levels are beginner, easy, medium, hard.
-
-=item B<set_problem_level> I<$problem>, I<$level>
-
-Sets a problem's level. The levels are beginner, easy, medium, hard.
-
-=item B<problem_difficulty> I<$problem>
-
-Returns a problem's difficulty.
-
-=item B<set_problem_difficulty> I<$problem>, I<$name>
-
-Sets a problem's difficulty.
-
-=item B<problem_statement> I<$problem>
-
-Returns a problem's statement.
-
-=item B<set_problem_statement> I<$problem>, I<$statement>
-
-Sets a problem's statement.
-
-=item B<problem_owner> I<$problem>
-
-Returns a problem's owner.
-
-=item B<set_problem_owner> I<$problem>, I<$owner>
-
-Sets a problem's owner.
-
-=item B<problem_author> I<$problem>
+sub _query {
+       my ($stat, @extra) = @_;
+       $db->query($statements{$stat}, @extra)
+}
 
-Returns a problem's author.
+my (%name_cache, %name_cache_time);
+use constant NAME_CACHE_MAX_AGE => 5;
 
-=item B<set_problem_author> I<$problem>, I<$author>
+sub _object_name {
+       my ($table, $id) = @_;
+       $name_cache_time{$table} //= 0;
+       if (time - $name_cache_time{$table} > NAME_CACHE_MAX_AGE) {
+               $name_cache_time{$table} = time;
+               $name_cache{$table} = {};
+               $name_cache{$table} = $db->select($table, 'id,name')->map;
+       }
 
-Sets a problem's author.
+       $name_cache{$table}{$id}
+}
 
-=item B<problem_private> I<$problem>
 
-Returns a problem's private flag (true if the problem is private, false otherwise).
+sub _add_names ($) { ## no critic (ProhibitSubroutinePrototypes)
+       my ($el) = @_;
+       return unless defined $el;
+       if (ref $el eq 'ARRAY') {
+               &_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}
+               }
+       }
 
-=item B<set_problem_private> I<$problem>, I<$private>
+       $el
+}
 
-Sets a problem's private flag.
+sub user_list { scalar _query('user_list_sth')->hashes }
 
-=item B<problem_generator> I<$problem>
+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;
 
-Returns a problem's generator. The generators are File, Run and Undef. More might be added in the future.
+       $ret;
+}
 
-=item B<set_problem_generator> I<$problem>, I<$generator>
+sub problem_list {
+       my (%args) = @_;
+       my @columns = @{PROBLEM_PUBLIC_COLUMNS()};
+       push @columns, 'solution' if $args{solution};
+       my %where;
+       $where{private} = 0 unless $args{contest} || $args{private};
+       $where{'cp.contest'} = $args{contest} if $args{contest};
+       $where{owner} = $args{owner} if $args{owner};
+
+       my $table = $args{contest} ? 'problems JOIN contest_problems cp ON cp.problem = id' : 'problems';
+       _add_names $db->select(\$table, \@columns, \%where, 'name')->hashes
+}
 
-Sets a problem's generator.
+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;
+       $ret->{limits} = $limits if @$limits;
+
+       if ($contest) {
+               $ret->{contest_start} = $contest->{start};
+               $ret->{contest_stop}  = $contest->{stop};
+               delete $ret->{solution}
+       }
 
-=item B<problem_runner> I<$problem>
+       $ret
+}
 
-Returns a problem's runner. The runners are File, Verifier and Interactive. More might be added in the future.
+sub contest_list { _add_names _query('contest_list_sth')->hashes }
+
+sub contest_entry { _add_names _query(contest_entry_sth => $_[0])->hash }
+
+sub contest_has_problem { _query('contest_has_problem_sth', @_[0, 1])->flat }
+
+sub job_list {
+       my (%args) = @_;
+       $args{page} = int ($args{page} // 1);
+       my %where = (
+               maybe contest => $args{contest},
+               maybe owner => $args{owner},
+               maybe problem => $args{problem},
+               maybe result => $args{result},
+       );
+       $where{private} = 0 unless $args{private};
+
+       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 = _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,
+               ($args{page} - 1) ? (previous_page => $args{page} - 1) : (),
+               ($args{page} < $pages) ? (next_page => $args{page} + 1) : (),
+       };
+       wantarray ? ($jobs, $pageinfo) : $jobs;
+}
 
-=item B<set_problem_runner> I<$problem>, I<$runner>
+sub job_entry {
+       my $ret = _add_names _query(job_entry_sth => $_[0])->hash;
+       $ret->{results} = decode_json $ret->{results} if $ret->{results};
+       $ret
+}
 
-Sets a problem's runner.
+sub create_job {
+       my (%args) = @_;
+       $db->update('users', {lastjob => time}, {id => $args{owner}});
+       purge '/log/';
+       scalar $db->insert('jobs', \%args, {returning => 'id'})->list
+}
 
-=item B<problem_judge> I<$problem>
+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)
+       $score = ($totaltime - $time) / $totaltime * $score;
+       $score -= $tries / 10 * $mxscore;
+       $score = $mxscore * 3 / 10 if $score < $mxscore * 3 / 10;
+       int $score + 0.5
+}
 
-Returns a problem's judge. The judges are Absolute and Points. More might be added in the future.
+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;
 
-=item B<set_problem_judge> I<$problem>, I<$judge>
+       my (%scores, %tries, %opens);
+       my $opens = _query(opens_sth => $ct->{id});
+       while ($opens->into(my ($problem, $owner, $time))) {
+               $opens{$problem, $owner} = $time;
+       }
 
-Sets a problem's judge.
+       my $jobs = $db->select('job_entry', '*', {contest => $ct->{id}}, 'id');
 
-=item B<problem_testcnt> I<$problem>
+       while (my $job = $jobs->hash) {
+               my $open = $opens{$job->{problem}, $job->{owner}} // $ct->{start};
+               my $time = $job->{date} - $open;
+               next if $time < 0; # uncoverable branch true job sent before contest is deprecated
+               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}));
+       }
 
-Returns a problem's test count.
+       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),
+                       score => sum (values %{$scores{$user}}),
+                       scores => [map { $scores{$user}{$_->{id}} // '-'} @problems],
+               }
+       } keys %scores;
 
-=item B<set_problem_testcnt> I<$problem>, I<$testcnt>
+       $st[0]->{rank} = 1 if @st;
+       $st[$_]->{rank} = $st[$_ - 1]->{rank} + ($st[$_]->{score} < $st[$_ - 1]->{score}) for 1 .. $#st;
 
-Sets a problem's test count.
+       \@st
+}
 
-=item B<problem_timeout> I<$problem>
+sub update_status {
+       my $jobs = $db->select('jobs', 'id,owner,problem,result', {-not_bool => 'private'}, 'id');
 
-Returns a problem's time limit, in seconds.
+       my %hash;
+       while ($jobs->into(my ($id, $owner, $problem, $result))) {
+               $hash{$problem, $owner} = [$id, $result ? 0 : 1];
+       }
 
-=item B<set_problem_timeout> I<$problem>, I<$timeout>
+       my @problem_statuses = map { [split ($;), @{$hash{$_}} ] } keys %hash;
 
-Sets a problem's time limit, in seconds.
+       my @contest_statuses = map {
+               my $ct = $_;
+               map { [$ct, $_->{user}, $_->{score}, $_->{rank}] } @{standings $ct}
+       } $db->select('contests', 'id')->flat;
 
-=item B<problem_olimit> I<$problem>
+       $db->begin;
+       $db->delete('problem_status');
+       $db->query('INSERT INTO problem_status (problem,owner,job,solved) VALUES (??)', @$_) for @problem_statuses;
+       $db->delete('contest_status');
+       $db->query('INSERT INTO contest_status (contest,owner,score,rank) VALUES (??)', @$_) for @contest_statuses;
+       $db->commit
+}
 
-Returns a problem's output limit, in bytes.
+sub rerun_job {
+       my ($id) = @_;
+       _query rerun_job_sth => $id;
+       purge '/log/';
+       purge "/log/$id";
+}
 
-=item B<set_problem_olimit> I<$problem>, I<$olimit>
+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
+}
 
-Sets a problem's output limit, in bytes.
+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};
+}
 
-=item B<get_open> I<$problem>, I<$user>
+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}) };
+}
 
-Returns the time when I<$user> opened I<$problem>.
+my @PURGE_HOSTS = exists $ENV{PURGE_HOSTS} ? split ' ', $ENV{PURGE_HOSTS} : ();
+my $ht = HTTP::Tiny->new;
 
-=item B<mark_open> I<$problem>, I<$user>
+sub purge {
+       $ht->request(PURGE => "http://$_$_[0]") for @PURGE_HOSTS;
+}
 
-Sets the time when I<$user> opened I<$problem> to the current time. Does nothing if I<$user> has already opened I<$problem>.
+1;
 
-=item B<insert_problem> I<$id>, I<$key> => I<$value>, ...
+__END__
 
-Inserts a problem with id I<$id> and the given initial configuration. Does nothing if a problem with id I<$id> already exists. Returns true if the problem was added, false otherwise.
+=encoding utf-8
 
-=item B<edit_problem> I<$id>, I<$key> => I<$value>, ...
+=head1 NAME
 
-Updates the configuration of a problem. The values of the given keys are updated. All other keys/values are left intact.
+Gruntmaster::Data - Gruntmaster 6000 Online Judge -- database interface and tools
 
-=item B<remove_problem> I<$id>
+=head1 SYNOPSIS
 
-Removes a problem.
 
-=back
+=head1 DESCRIPTION
 
-=head2 Contests
+Gruntmaster::Data is the interface to the Gruntmaster 6000 database.
 
-B<<< WARNING: these functions only work correctly when C<< $Gruntmaster::Data::contest >> is undef >>>
+All functions are exported by default.
 
 =over
 
-=item B<contests>
-
-Returns a list of contests.
+=item B<dbinit>(I<@args>)
 
-=item B<contest_start> I<$contest>
+This function connects to the database. I<@args> are the arguments
+passed to the L<DBIx::Simple> constructor.
 
-Returns a contest's start time.
+=item B<purge>(I<$url_path>)
 
-=item B<set_contest_start> I<$contest>, I<$start>
+Purges a relative URL from the Varnish Cache by sending PURGE
+$url_path requests to all hosts in the PURGE_HOSTS environment
+variable.
 
-Sets a contest's start time.
+=item B<db>
 
-=item B<contest_end> I<$contest>
+Returns a L<DBIx::Simple> object for interacting with the database
+directly. Use this when no other function in this module is suitable.
 
-Returns a contest's end time.
+=item B<user_list>
 
-=item B<set_contest_end> I<$contest>, I<$end>
+Returns an arrayref of the top 200 users.
 
-Sets a contest's end time.
+=item B<user_entry>(I<$id>)
 
-=item B<contest_name> I<$contest>
+Returns a hashref describing the user I<$id>.
 
-Returns a contest's name.
+=item B<problem_list>([I<%args>])
 
-=item B<set_contest_name> I<$contest>, I<$name>
+Returns an arrayref of problems.
 
-Sets a contest's name.
-
-=item B<contest_owner> I<$contest>
-
-Returns a contest's owner.
-
-=item B<set_contest_owner> I<$contest>, I<$owner>
-
-Sets a contest's owner.
-
-=item B<insert_contest> I<$id>, I<$key> => I<$value>, ...
-
-Inserts a contest with id I<$id> and the given initial configuration. Does nothing if a contest with id I<$id> already exists. Returns true if the contest was added, false otherwise.
-
-=item B<edit_contest> I<$id>, I<$key> => I<$value>, ...
-
-Updates the configuration of a contest. The values of the given keys are updated. All other keys/values are left intact.
-
-=item B<remove_contest> I<$id>
-
-Removes a contest.
-
-=back
-
-=head2 Jobs
+Takes the following named arguments:
 
 =over
 
-=item B<jobcard>
-
-Returns the number of jobs in the database.
-
-=item B<job_results> I<$job>
-
-Returns an array of job results. Each element corresponds to a test and is a hashref with keys B<id> (test number), B<result> (result code, see L<Gruntmaster::Daemon::Constants>), B<result_text> (result description) and B<time> (time taken).
-
-=item B<set_job_results> I<$job>, I<$results>
-
-Sets a job's results.
-
-=item B<job_inmeta> I<$job>
-
-Returns a job's meta.
+=item owner
 
-=item B<set_job_inmeta> I<$job>, I<$meta>
+Only show problems owned by this user
 
-Sets a job's meta.
+=item contest
 
-=item B<job_daemon> I<$job>
+Only show problems in this contest
 
-Returns the hostname:pid of the daemon which ran this job.
+=item private
 
-=item B<set_job_daemon> I<$job>, I<$hostname_and_pid>
+If true, include private problems. Always true if contest is present.
 
-If the job has no associated daemon, it sets the daemon and returns true. Otherwise it returns false without setting the daemon.
+=item solution
 
-=item B<job_date> I<$job>
+If true, include problem solutions
 
-Returns a job's submit date.
-
-=item B<set_job_date> I<$job>, I<$date>
-
-Sets a job's submit date.
-
-=item B<job_errors> I<$job>
-
-Returns a job's compile errors.
-
-=item B<set_job_errors> I<$job>, I<$errors>
-
-Sets a job's compile errors.
-
-=item B<job_extension> I<$job>
-
-Returns a job's file name extension (e.g. "cpp", "pl", "java").
-
-=item B<set_job_extension> I<$job>, I<$extension>
-
-Sets a job's file name extension.
-
-=item B<job_filesize> I<$job>
-
-Returns a job's source file size, in bytes.
-
-=item B<set_job_filesize> I<$job>, I<$filesize>
-
-Sets a job's source file size, in bytes.
-
-=item B<job_private> I<$job>
-
-Returns the value of a job's private flag.
-
-=item B<set_job_private> I<$job>, I<$private>
-
-Sets the value of a job's private flag.
-
-=item B<job_problem> I<$job>
-
-Returns a job's problem.
-
-=item B<set_job_problem> I<$job>, I<$problem>
-
-Sets a job's problem.
-
-=item B<job_result> I<$job>
-
-Returns a job's result code. Possible result codes are described in L<Gruntmaster::Daemon::Constants>
-
-=item B<set_job_result> I<$job>, I<$result>
-
-Sets a job's result code.
-
-=item B<job_result_text> I<$job>
-
-Returns a job's result text.
-
-=item B<set_job_result_text> I<$job>, I<$result_text>
-
-Sets a job's result text.
-
-=item B<job_user> I<$job>
-
-Returns the user who submitted a job.
-
-=item B<set_job_user> I<$job>, I<$user>
-
-Sets the suer who submitted a job.
+=back
 
-=item B<clean_job> I<$job>
+=item B<problem_entry>(i<$id>, [I<$contest>])
 
-Removes a job's daemon, result code, result text and result array.
+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 B<push_job> I<$key> => I<$value>, ...
+=item B<contest_list>
 
-Inserts a job with a given initial configuration. Returns the id of the newly-added job.
+Returns an arrayref of contests.
 
-=item B<edit_job> I<$id>, I<$key> => I<$value>, ...
+=item B<contest_entry>(I<$id>)
 
-Updates the configuration of a job. The values of the given keys are updated. All other keys/values are left intact.
+Returns a hashref describing the contest I<$id>.
 
-=item B<remove_job> I<$id>
+=item B<contest_has_problem>(I<$contest>, I<$problem>)
 
-Removes a job.
+Returns true if the contest I<$contest> includes the problem
+I<$problem>, false otherwise.
 
-=back
+=item B<job_list>([I<%args>])
 
-=head2 Users
+In scalar context, returns an arrayref of jobs. In list context,
+returns an arrayref of jobs and a hashref of information about pages.
 
-B<<< WARNING: these functions only work correctly when C<< $Gruntmaster::Data::contest >> is undef >>>
+Takes the following named arguments:
 
 =over
 
-=item B<users>
-
-Returns a list of users.
-
-=item B<user_name> I<$user>
+=item page
 
-Returns a user's full name.
+Show this page of the job log. Defaults to 1.
 
-=item B<set_user_name> I<$user>, I<$name>
+=item owner
 
-Sets a user's full name.
+Only show jobs submitted by this user.
 
-=item B<user_email> I<$user>
+=item contest
 
-Returns a user's email address.
+Only show jobs submitted in this contest.
 
-=item B<set_user_email> I<$user>, I<$email>
+=item problem
 
-Sets a user's email address.
+Only show jobs submitted for this problem.
 
-=item B<user_lastjob> I<$user>
+=item result
 
-Returns the time (seconds since epoch) when the user last submitted a solution.
+Only show jobs with this result (see the constants in
+L<Gruntmaster::Daemon::Constants>).
 
-=item B<set_user_lastjob> I<$user>, I<$lastjob>
+=item private
 
-Sets the time (seconds since epoch) when the user last submitted a solution.
+If true, include private jobs. Defaults to false.
 
-=item B<user_town> I<$user>
-
-Returns a user's town.
+=back
 
-=item B<set_user_town> I<$user>, I<$town>
+=item B<job_entry>(I<$id>)
 
-Sets a user's town.
+Returns a hashref describing the job I<$id>.
 
-=item B<user_university> I<$user>
+=item B<create_job>(I<%args>)
 
-Returns a user's university/highschool/place of work/etc.
+Insert a new job into the database. This function also updates the
+lastjob field for the job's owner.
 
-=item B<set_user_university> I<$user>, I<$university>
+=item B<standings>(I<$ct>)
 
-Sets a user's university, highschool/place of work/etc.
+Returns an arrayref of the standings of contest I<$ct>.
 
-=item B<user_level> I<$user>
+=item B<update_status>
 
-Returns a user's current level of study. One of 'Highschool', 'Undergraduate', 'Master', 'Doctorate' or 'Other'.
+Rebuilds the problem_status and contest_status tables.
 
-=item B<set_user_level> I<$user>, I<$level>
+=item B<rerun_job>(I<$id>)
 
-Sets a user's current level of study.
+Marks the job $id as pending and clears its results, so that it will
+be run again by the daemon.
 
-=item B<insert_user> I<$id>, I<$key> => I<$value>, ...
+=item B<take_job>(I<$daemon>)
 
-Inserts a user with id I<$id> and the given initial configuration. Does nothing if a user with id I<$id> already exists. Returns true if the user was added, false otherwise.
+Marks a random job as being run by I<$daemon>. Returns a hashref
+describing the job, or undef if no job was available.
 
-=item B<edit_user> I<$id>, I<$key> => I<$value>, ...
+=item B<finish_job>(I<$job>, I<$private>, I<%results>)
 
-Updates the configuration of a user. The values of the given keys are updated. All other keys/values are left intact.
+Updates the job $job with the results in %results. If $private is
+false, also updates the problem_status table.
 
-=item B<remove_user> I<$id>
+=item B<open_problem>(I<$contest>, I<$problem>, I<$owner>, I<$time>)
 
-Removes a user.
+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
 
@@ -531,12 +467,11 @@ 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 terms of the GNU Affero General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+This library is free software; you can redistribute it and/or modify
+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.
 
 
 =cut
This page took 0.024306 seconds and 4 git commands to generate.