Changes between Version 15 and Version 16 of BossaExampleOne

Timestamp:

Jul 20, 2008, 8:01:58 PM (16 years ago)

Author:

davea

Comment:

--

BossaExampleOne

@@ -70 +70 @@
 == Displaying jobs ==
 
-Next we'll explain the script that displays a job to a volunteer
-and handles their response: [source:/trunk/boinc/html/user/bossa_example.php bossa_example_display.php].
+The application is described by a PHP file ([source:/trunk/boinc/html/inc/bossa_example.inchtml/inc/bossa_example.inc])
+that contains several functions.
+
+The first of these displays a job:
 {{{
-function show_job($bj, $bji) {
-    $info = json_decode($bj->info);
-    $img_url = $info->url;
+function job_show($job, $inst, $user) {
+    $info = $job->get_info($job);
+    $path = $info->path;
+    page_head("Find the Ellipse");
     echo "
-        <form method=get action='bossa_example_display.php'>
+        <form method=get action=bossa_job_finished.php>
         Click on the center of the ellipse.
         If you don't see one, click here:
-        <br><br><input type=submit name=submit value=None>
-        <input type=hidden name=bji value=$bji->id>
-        <input type=hidden name=completion value=1>
-        <input type=image name=pic src='$img_url'>
+        <input type=submit name=submit value=None>
+        <br><br>
+        <input type=hidden name=bji value=$inst->id>
+        <input type=image name=pic src=$path>
         </form>
     ";
+    page_tail();
 }
+}}}
 
-function handle_job_completion($bj, $bji) {
+The second is called when a job is issued:
+
+{{{
+function job_issued($job, $inst, $user) {
+    $job->set_priority(0);
+}
+}}}
+
+It sets the job's priority to zero so that no further instances will be issued
+(unless this one times) out.
+
+The next function is called when a job instance is finished.
+It gets the user's response to the job,
+and stores it in the instance's app data field.
+{{{
+function job_finished($job, $inst) {
     $response = null;
     if (get_str('submit', true)) {
@@ -94 +114 @@
     } else {
         $response->have_ellipse = 1;
-        $response->cx = get_int('pic.x');
-        $response->cy = get_int('pic.y');
+        $response->cx = get_int('pic_x');
+        $response->cy = get_int('pic_y');
     }
-    $bji->info = json_encode($response);
-    $bji->completed($bj);
-    Bossa::show_next_job($bj);    // show another job immediately
-}
-
-Bossa::script_init($user, $bj, $bji);
-
-if (isset($_GET['completion'])) {
-    handle_job_completion($bj, $bji);
-} else {
-    show_job($bj, $bji);
+    $inst->update_info($response);
 }
 }}}
 
-The script calls '''Bossa::script_init()''' to get PHP objects describing
-the user, the job, and the job instance.
-
-'''show_job()''' decodes the job description to get the image URL,
-and displays the image in an HTML page that
-lets the user click on the image or on a "No ellipse" button.
-
-'''handle_job_completion()''' gets the user's response (from form variables).
-It calls the '''completed()''' method of the job,
-passing it a JSON encoding of the response.
-I then calls '''Bossa::show_next_job()''' to immediately display another job.
-
-== Handling completed results ==
-
-Finally, we need to specify how results are handled.
-This is specified in [source:/trunk/boinc/html/inc/bossa_example_backend.inc bossa_example_backend.inc].
-
-This defines two functions, which must have names '''X_compare''' and '''X_handle'''
-where X is the application's short name.
-
-The first function compares two instances and decides if they are compatible:
+The next function is called when a job times out.
+It restores the priority to one so that the job will
+be issued to another volunteer.
 {{{
-function bossa_example_compare($r1, $r2) {
-    if ($r1->have_ellipse) {
-        if ($r2->have_ellipse) {
-            $dx = ($r1->cx - $r2->cx);
-            $dy = ($r1->cy - $r2->cy);
-            $dsq = $dx*$dx + $dy*$dy;
-            return ($dsq < 400);
-        } else return false;
-    } else {
-        return !$r2->have_ellipse;
-    }
-}
-}}}
-In this case, two instances are considered compatible if either
- * neither of them found an ellipse, or
- * they both found an ellipse and the centers are within 20 pixels
-
-The second function specifies what happens when a job has been completed,
-i.e. a consensus set has been found:
-{{{
-function bossa_example_handle($bj, $c) {
-    $res = $c[0];
-    if ($res->have_ellipse) {
-        $res->cx = 0;
-        $res->cy = 0;
-        foreach ($c as $r) {
-            $res->cx += $r->cx;
-            $res->cy += $r->cy;
-        }
-        $res->cx /= count($c);
-        $res->cy /= count($c);
-    }
-
-    $info = json_decode[$bj->info);
-    $info->result = $res;
-    $i = json_encode($info);
-    $bj->update("info='$i'");
+function job_timed_out($job, $inst, $user) {
+    $job->set_priority(1);
 }
 }}}
 
-This function is called with the BossaJob record ($bj) and an
-array of job instances in the consensus set ($c).
-In this case, we average the center positions (if an ellipse was found)
-and store the JSON-encoded result in the '''info''' field of the job record.
+The remaining functions return short strings
+that show the app data for jobs, instances, and users
+on the Admin page:
+{{{
+function job_summary($job) {
+    $info = $job->get_info();
+    return "<a href=".URL_BASE."$info->path>View image</a>";
+}
+
+function instance_summary($inst) {
+    $info = $inst->get_info();
+    if ($info->have_ellipse) {
+        return "($info->cx, $info->cy)";
+    } else {
+        return "no ellipse";
+    }
+}
+
+function show_user_summary($user) {
+}
+}}}