uotd.inc

<?php
// This file is part of BOINC.
// http://boinc.berkeley.edu
// Copyright (C) 2015 University of California
//
// BOINC is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation,
// either version 3 of the License, or (at your option) any later version.
//
// BOINC is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with BOINC.  If not, see <http://www.gnu.org/licenses/>.

require_once('../inc/boinc_db.inc');
require_once('../inc/email.inc');
require_once('../inc/profile.inc');

if (!defined('UOTD_THRESHOLD')) {
    define('UOTD_THRESHOLD', 7);
    // email sysadmin if # of UOTD candidates falls below this
}

function uotd_thumbnail($profile, $user) {
    if ($profile->has_picture) {
        return "<a href=\"".url_base()."view_profile.php?userid=$user->id\"><img border=0 vspace=4 hspace=8 align=left src=\"".profile_thumb_url($user->id)."\" alt=\"".tra("User profile")."\"></a>";
    } else {
        return "";
    }
}

// show UOTD in a small box
//
function show_uotd($profile) {
    $user = BoincUser::lookup_id($profile->userid);
    echo uotd_thumbnail($profile, $user);
    echo user_links($user, BADGE_HEIGHT_MEDIUM)."<br>";
    $x = output_transform($profile->response1);
    $x = sanitize_tags($x);
    echo sub_sentence($x, ' ', 150, true);
}

// return the last UOTD profile, or null
//
function get_current_uotd() {
    $profiles = BoincProfile::enum("uotd_time is not NULL and uotd_time>0", "ORDER BY uotd_time DESC LIMIT 1");
    if (sizeof($profiles)) {
        return $profiles[0];
    }
    return null;
}

// Select a (possibly new) UOTD
//
function select_uotd($force_new = false) {
    echo gmdate("F d Y", time())." UTC: Starting\n";
    $current_uotd = get_current_uotd();
    if ($current_uotd && !$force_new) {
        $assigned = getdate($current_uotd->uotd_time);
        $now = getdate(time());
        if ($assigned['mday'] == $now['mday']) {
            $user = BoincUser::lookup_id($current_uotd->userid);
            echo "Already have UOTD for today\n";
            generate_uotd_gadget($current_uotd, $user);
            exit();
        }
    }
    if ($force_new) {
        echo "Forcing new UOTD\n";
    }

    // get a list of profiles that have been 'approved' for UOTD,
    // using a project-specific query if supplied in project.inc
    //
    if (function_exists('uotd_candidates_query')) {
        $query = uotd_candidates_query();
        echo "using project supplied candidates_query\n";
    } else {
        $query = default_uotd_candidates_query();
        echo "using default candidates_query\n";
    }
    $db = BoincDb::get();
    $result = $db->do_query($query);

    // If the number of approved profiles dips below a threshold,
    // email the sys admin every time we pick a new one.
    //
    if (defined('UOTD_ADMIN_EMAIL')
        && $result
        && $result->num_rows < UOTD_THRESHOLD
    ) {
        echo "approved candidates for UOTD under UOTD_THRESHOLD\n";
        $u = new BoincUser;
        $u->email_addr = UOTD_ADMIN_EMAIL;
        $u->name = "UOTD admin";
        send_email($u,
            PROJECT . ": User of the Day pool is running low!",
            "The pool of approved candidates for User of the Day has".
            " reached your assigned threshold: there are now only " . $result->num_rows . " approved users.\n\n".
            "To approve more candidates for User of the Day,".
            " go to the " . PROJECT . " administration page and click \"Screen user profiles\""
        );
    }

    if ($result && $result->num_rows == 0) {
        echo "no new verified profile found, selecting old UOTD that was shown least recently\n";
        $result->free();
        // If all verified profiles have been selected as UOTD,
        // reshow a random one of the 100 least recently shown profiles.
        //
        $inner = "SELECT profile.userid FROM profile,user WHERE profile.userid=user.id AND verification=1 AND uotd_time>0 ORDER BY uotd_time ASC LIMIT 100";
        $result = $db->do_query("SELECT * from ($inner) as t ORDER BY RAND() LIMIT 1");
    }

    if (!$result || $result->num_rows == 0) {
        // No valid users of the day - do something.
        echo "No screened users found\n";
        exit();
    }
    $candidate = $result->fetch_object();
    $result->free();

    // depending on the candidates query the profile must not exist
    //
    $profile = BoincProfile::lookup_userid($candidate->userid);
    if (!$profile) {
        echo "Could not find profile returned from candidates query.\n";
        exit();
    }

    // "orphaned" profiles can only be detected if the candidate query doesn't join profile and user table
    // if this happens, delete the profile and try again
    //
    $user = BoincUser::lookup_id($candidate->userid);
    if (!$user) {
        echo "Profile for user $candidate->userid is orphaned and will be deleted\n";
        $profile->delete();
        select_uotd($force_new);
        exit();
    }

    $profile->uotd_time = time();
    $profile->update("uotd_time = ".time());

    send_email($user,
        "You're the " . PROJECT . " user of the day!",
        "Congratulations!\n\nYou've been chosen as the "
        . PROJECT . " user of the day!
        Your profile will be featured on the " . PROJECT . " website for the next 24 hours."
    );
    echo "Chose user $user->id as UOTD\n";

    generate_uotd_gadget($profile, $user);
}

// This query defines the set of users eligible to be UOTD.
// To override this with your own policy, create a similar function in
// your own project.inc called uotd_candidates_query()
//
function default_uotd_candidates_query(){
    $query = "SELECT * FROM profile,user WHERE profile.userid=user.id ";
    $query .= " AND verification=1 ";
    $query .= " AND expavg_credit>1 ";
    $query .= " AND (uotd_time IS NULL or uotd_time=0) ";
    $query .= "ORDER BY RAND()";
    return $query;
}

// get a list of profiles that have been 'approved' for UOTD,
// using a project-specific query if supplied in project.inc
//
function count_uotd_candidates(){
    $n = -1;                    // negative value returned on error
    if (function_exists('uotd_candidates_query')) {
        $query = uotd_candidates_query();
    } else {
        $query = default_uotd_candidates_query();
    }
    
    $db = BoincDb::get();
    $result = $db->do_query($query);
    if($result) {
        $n = $result->num_rows;
    }
    $result->free();
    
    return $n;
}

// iGoogle gadget  - generate the gadget content page
//
function generate_uotd_gadget($profile, $user) {
    $x = "<font size='2'>\n";
    $gadget =  PROFILE_PATH."uotd_gadget.html";
    if( $h = fopen($gadget, "w") ){
        $age = time()-$profile->uotd_time;
        echo "age: $age";
        if($age <= 86400+3600) { // allow for slop
            $x .= uotd_thumbnail($profile, $user);
            $x .= user_links($user, BADGE_HEIGHT_MEDIUM);
            $resp = sanitize_tags(output_transform($profile->response1));
            $x .= "&nbsp;&nbsp;". sub_sentence($resp, ' ', 250, true);
        }
        else {
            $x .= "<font color='fuscia'>
                There is no User of the Day today.
                Only volunteers who have created a Profile
                (with a picture), and have recent credit,
                are eligible to be chosen as User of the Day.
                We have run out of these, so there isn't a
                User of the Day.
                </font>";
        }
        $x .= "\n</font>\n";
        fwrite($h, $x);
        fclose($h);
    }
}

?>