Changes between Version 6 and Version 7 of AppFiltering

Timestamp:

Jul 20, 2016, 3:33:34 PM (9 years ago)

Author:

davea

Comment:

--

AppFiltering

@@ -1 @@
-= User app selection =
+= User app filtering =
 
-You can allow users to select which applications they will receive work for
-(by default, they may receive work for any application).
+BOINC offers two mechanisms allowing users to control the set of apps for which they get jobs.
+The first, described [BetaTest here], lets you designate apps as "beta test", and lets users opt-in to getting jobs for these apps.
+The second, "app filtering", lets users select apps individually.
 
-Each user's list of selected apps is stored in the [ProjectSpecificPrefs project-specific preferences].
-This is stored in the user.project_specific_prefs database field.
-Each 'allowed' application is represented by an element {{{<app_id>N</app_id>}}},
-where N is the database ID of the application.
-If no {{{<app_id>}}} elements are present, the user may be sent work for any application.
-
-This feature is disabled by default.
-To enable it, edit your html/project/project_specific_prefs.inc to contain
+App filtering is disabled by default.
+To enable it, add to your html/project/project_specific_prefs.inc:
 {{{
 define ('APP_SELECT_PREFS', true);
 }}}
+
+The app filtering user interface is part of [ProjectSpecificPrefs project-specific preferences]
+(i.e., the "Preferences for this project" link on their account page).
+If the feature is enabled, users are shown:
+ * A list of apps and check boxes.
+ * A checkbox labeled "If no work for selected applications is available, accept work from other applications?".
+
+If no apps are selected, there is no restriction: the user can be sent jobs for any app.
+When you first enable app filtering, no apps are selected.
+Hence all users can get all apps.
+Post a news item to notify users that app filtering is available.
+
+== Defining default app selection ==
+
+Suppose you want to define a default other than enabling all apps.
+For new users you can do this by adding some lines to your
+'''html/project/project_specific_prefs.inc''':
+{{{
+function project_specific_prefs_default() {
+        ... existing code
+        $x .= "<app_id>ID1</app_id>\n";
+        ...
+        $x .= "<app_id>IDn</app_id>\n";
+}}}
+where ID1 ... IDn are the database IDs of the apps to enable by default.
+
+This specifies default prefs for new users, but it doesn't affect existing users.
+Setting prefs for existing users, ''en masse'', will require some new code; ask David Anderson.
 
 == Adding a new app ==
@@ -29 +52 @@
 see the bottom of the script for details on how to do this.
 
-== Warning ==
+== Disabling app filtering ==
 
-Once you use application filtering,
-currently there is no easy way to cancel it:
-users who have non-empty app lists will continue to
-be filtered even if you remove app filtering from your PHP code.
-The only ways to fully undo app filtering are:
+Currently there's no way to disable app filtering;
+if you undefine APP_SELECT_PREFS, the GUI will go away
+but existing prefs will continue to be enforced.
+To fix this we'll need to add a scheduler flag to disable app filtering;
+if you need this, ask me (David Anderson).
 
- * write a script to remove all <app_id> elements from the XML in the database
- * modify the scheduler so that it takes a configuration flag turning off app filtering.
+== Implementation ==
+
+Each user's list of selected apps is stored in the user.project_specific_prefs database field.
+Each 'allowed' application is represented by an element {{{<app_id>N</app_id>}}},
+where N is the database ID of the application.
+