User Opt-in consent

db/schema.sql

@@ -804,3 +804,27 @@ create table host_deleted (
     primary key (hostid)
 ) engine=InnoDB;
 
+create table consent (
+    id                      integer         not null auto_increment,
+    userid                  integer         not null,
+    consent_name            varchar(255)    not null,
+    consent_time            integer         not null,
+    consent_flag            tinyint         not null,
+    consent_not_required    tinyint         not null,
+    source                  varchar(255)    not null,
+    primary key (id)
+) engine=InnoDB;
+
+create table consent_type (
+    consent_id              integer         not null auto_increment,
+    shortname               varchar(255)    not null,
+    description             varchar(255)    not null,
+    enabled                 integer         not null,
+    protected               integer         not null,
+    privacypref             integer         not null,
+    primary key (consent_id)
+) engine=InnoDB;
+
+insert into consent_type (consent_id, shortname, description, enavled, protected, privacypref)
+    values (1, 'ENROLL', 'General terms-of-use for this BOINC project.', 0, 1, 0);
+    values (2, 'STATSEXPORT', 'Do you consent to exporting your data to BOINC statistics aggregation Web sites?', 0, 1, 1);

html/inc/account.inc

@@ -20,6 +20,8 @@
 // - forms for create / login
 // - function to make login token
 
+include_once("../inc/consent.inc");
+
 // If have recent token, return it.
 // Else make login token, store in user record, return token
 //
@@ -113,6 +115,23 @@ function create_account_form($teamid, $next_url) {
             "postal_code"
         );
     }
+
+    // Add terms of use to Web form. User must agree by checking the checkbox.
+    $tou_file = "../../terms_of_use.txt";
+    if ( check_consent_type('ENROLL') and file_exists($tou_file) ) {
+        $terms_of_use = trim(file_get_contents($tou_file));
+        if ($terms_of_use) {
+            panel('Terms of Use', function() use($terms_of_use) {
+                echo nl2br($terms_of_use);
+            }
+            );
+            $myitems = array(
+                array("agree_to_terms_of_use", "", false),
+            );
+            form_checkboxes(tra("Do you agree to the terms of use above?"), $myitems, 'tabindex="0"');
+        }
+    }
+
 }
 
 function login_form($next_url) {
@@ -140,4 +159,28 @@ function login_form($next_url) {
     form_end();
 }
 
+function user_agreetermsofuse_form($next_url) {
+    form_start(secure_url_base()."/user_agreetermsofuse_action.php", "post");
+    form_input_hidden("next_url", $next_url);
+
+    $tou_file = "../../terms_of_use.txt";
+    $terms_of_use = trim(file_get_contents($tou_file));
+    if ($terms_of_use) {
+        panel('Terms of Use', function() use($terms_of_use) {
+            echo nl2br($terms_of_use);
+        }
+        );
+        $myitems = array(
+            array("agree_to_terms_of_use", "", false),
+        );
+        form_checkboxes(tra("Do you agree to the terms of use above?"), $myitems, 'tabindex="0"');
+    }
+    else {
+        // error - no terms of use for user to agree to!
+    }
+
+    form_submit("I agree");
+    form_end();
+}
+
 ?>

html/inc/boinc_db.inc

@@ -880,6 +880,72 @@ class BoincHostDeleted {
 
 }
 
+class BoincConsent {
+    static function lookup($clause) {
+        $db = BoincDb::get();
+        return $db->lookup('consent', 'BoincConsent', $clause);
+    }
+
+    static function enum($where_clause) {
+        $db = BoincDb::get();
+        return $db->enum('consent', 'BoincConsent', $where_clause);
+    }
+
+    static function insert ($clause) {
+        $db = BoincDb::get();
+        return $db->insert('consent', $clause);
+    }
+
+    static function update ($clause) {
+        $db = BoincDb::get();
+        return $db->update_aux('consent', $clause);
+    }
+
+    static function delete($clause) {
+        $db = BoincDb::get();
+        return $db->delete_aux('consent', $clause);
+    }
+
+    static function delete_for_user($user_id) {
+        $db = BoincDb::get();
+        $db->delete_aux('consent', "userid=$user_id");
+        return $db->affected_rows();
+    }
+
+}
+
+class BoincConsentType {
+    static function lookup($clause) {
+        $db = BoincDb::get();
+        return $db->lookup('consent_type', 'BoincConsentType', $clause);
+    }
+
+    static function enum($where_clause, $order_clause=null) {
+        $db = BoincDb::get();
+        return $db->enum('consent_type', 'BoincConsentType', $where_clause, $order_clause);
+    }
+
+    static function insert ($clause) {
+        $db = BoincDb::get();
+        return $db->insert('consent_type', $clause);
+    }
+
+    static function update ($clause) {
+        $db = BoincDb::get();
+        return $db->update_aux('consent_type', $clause);
+    }
+
+    function delete() {
+        $db = BoincDb::get();
+        return $db->delete($this, 'consent_type');
+    }
+
+    function delete_aux($clause) {
+        $db = BoincDb::get();
+        return $db->delete_aux('consent_type', $clause);
+    }
+
+}
 
 // DEPRECATED: use BoincDb::escape_string where possible
 // 

html/inc/consent.inc

@@ -0,0 +1,70 @@
+<?php
+// This file is part of BOINC.
+// http://boinc.berkeley.edu
+// Copyright (C) 2017 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/>.
+
+// functions dealing with the consent and consent_type tables.
+
+include_once("../inc/boinc_db.inc");
+include_once("../inc/util.inc");
+
+function consent_to_a_policy($user, $consent_name, $consent_flag, $consent_not_required, $source, $ctime = 0) {
+    $myn = BoincDb::escape_string($consent_name);
+    $mys = BoincDb::escape_string($source);
+    if ($ctime==0) {
+        $mytime = $user->create_time;
+    }
+    else {
+        $mytime = $ctime;
+    }
+    return BoincConsent::insert(
+        "(id, userid, consent_name, consent_time, consent_flag, consent_not_required, source) " .
+        "values(0, $user->id, '$myn', $mytime, $consent_flag, $consent_not_required, '$mys')"
+    );
+
+}
+
+function consent_after_login($user, $perm=true, $next_url = "") {
+    session_start();
+    $_SESSION['user'] = $user;
+    $_SESSION['perm'] = $perm;
+    $save_url = $next_url;
+    $consent_result = BoincConsent::lookup("userid={$user->id} AND consent_name='ENROLL' ORDER BY consent_time DESC LIMIT 1");
+    if ($consent_result) {
+        if ($consent_result->consent_flag != 1) {
+            $next_url = "user_agreetermsofuse.php?next_url=$save_url";
+        }
+        else{
+            send_cookie('auth', $user->authenticator, $perm);
+            session_unset();
+            session_destroy();
+        }
+    }
+    else {
+        $next_url = "user_agreetermsofuse.php?next_url=$save_url";
+    }
+    return $next_url;
+}
+
+// Checks to see if a particular consent_type name is in available and
+// enabled.
+function check_consent_type($name) {
+    $ct = BoincConsentType::lookup("shortname = '{$name}'");
+    if ($ct and ($ct->enabled)) {
+        return TRUE;
+    }
+    return FALSE;
+}

html/inc/delete_account.inc

@@ -186,6 +186,7 @@ function wipe_account($user) {
 
     BoincHostAppVersion::delete_for_user($user->id);
     BoincHost::delete_for_user($user->id);
+    BoincConsent::delete_for_user($user->id);
 
     // final action
     delete_user($user);  //from user_util.inc

html/inc/prefs.inc

@@ -588,7 +588,7 @@ function print_prefs_form(
         prefs_form_project($prefs, $error);
         if (!$venue) {
             prefs_form_privacy($user);
-            venue_form($user);
+            prefs_form_consent($user);
         }
         prefs_form_project_specific($prefs->project_specific, $project_error);
     }

html/inc/prefs_project.inc

@@ -137,6 +137,21 @@ $privacy_pref_descs = array (
     ),
 );
 
+// Privacy preferences located in consent_type table. Loop over the
+// table and extract those consent types with enabled=1 and
+// privacypref=1.
+$privacy_consent_descs = array();
+$_consenttypes = BoincConsentType::enum("enabled=1 AND privacypref=1", "ORDER BY protected DESC");
+foreach ($_consenttypes as $ct) {
+    $privacy_consent_descs[] = new PREF_CONSENT(
+        tra($ct->description),
+        tra($ct->description),
+        "consent_".urlencode($ct->shortname),
+        $ct->shortname,
+        0
+    );
+}
+
 global $text;
 global $parse_result;
 global $top_parse_result;
@@ -254,6 +269,19 @@ function prefs_show_privacy($user, $columns) {
     }
 }
 
+function prefs_show_consent($user, $columns) {
+    global $privacy_consent_descs;
+    if ($columns) {
+        foreach ($privacy_consent_descs as $p) {
+            $p->consent_show_cols($user);
+        }
+    } else {
+        foreach ($privacy_consent_descs as $p) {
+            $p->consent_show($user);
+        }
+    }
+}
+
 function prefs_show_project_specific($prefs, $columns=false) {
     if ($columns) {
         $project_specific_prefs = project_specific_prefs_parse($prefs->project_specific);
@@ -287,6 +315,7 @@ function print_prefs_display_project($user, $columns=false) {
         }
         prefs_show_project($project_prefs, false);
         prefs_show_privacy($user, false);
+        prefs_show_consent($user, false);
         venue_show($user);
         prefs_show_project_specific($project_prefs, false);
         $tokens = url_tokens($user->authenticator);
@@ -311,6 +340,13 @@ function prefs_form_privacy($user) {
     }
 }
 
+function prefs_form_consent($user) {
+    global $privacy_consent_descs;
+    foreach ($privacy_consent_descs as $p) {
+        $p->consent_show_form_row($user, false);
+    }
+}
+
 function prefs_form_project($prefs, $error=false) {
     global $project_pref_descs;
     foreach ($project_pref_descs as $p) {
@@ -341,6 +377,15 @@ function prefs_privacy_parse_form(&$user) {
     return $error;
 }
 
+function prefs_consent_parse_update(&$user) {
+    global $privacy_consent_descs;
+    $error = false;
+    foreach ($privacy_consent_descs as $p) {
+        $p->parse_form($user, $error);
+    }
+    return $error;
+}
+
 // Parse the project specific prefs form.
 // For details see project/project_specific_prefs.inc
 //