lib/SGN/Controller/AJAX/Calendar.pm

   1
   2 =head1 NAME
   3
   4 SGN::Controller::AJAX::Calendar - a REST controller class to provide the
   5 backend for displaying, adding, deleting, dragging, modifying, and requesting more info about events. All calendar related functions are here.
   6
   7 =head1 DESCRIPTION
   8
   9 Calendar events are saved in the projectprop table value field as a tuple of the format {"2007-09-21T00:00:00","2007-09-21T00:00:00","N/A","#"} which correspond to the start datetime, end datetime, description, and web url, respectively.
  10
  11 The calendar can display events for projects (breeding programs and their trials) which a user has a role for in the sp_person_roles table.
  12
  13
  14 =head1 AUTHOR
  15
  16 Nicolas Morales <nm529@cornell.edu>
  17 Created: 08/01/2015
  18 Modified: 10/21/2015
  19
  20 =cut
  21
  22
  23 package SGN::Controller::AJAX::Calendar;
  24
  25 use strict;
  26 use Moose;
  27 use JSON;
  28 use Time::Piece;
  29 use Time::Seconds;
  30 use Data::Dumper;
  31 use CXGN::Login;
  32 use SGN::Model::Cvterm;
  33 use CXGN::Calendar;
  34
  35 BEGIN { extends 'Catalyst::Controller::REST' }
  36
  37 __PACKAGE__->config(
  38     default   => 'application/json',
  39     stash_key => 'rest',
  40     map       => { 'application/json' => 'JSON', 'text/html' => 'JSON' },
  41    );
  42
  43
  44 =head2 /ajax/calendar/populate/personal/{view}
  45
  46  Usage: When the calendar is loaded and when controls (such as next month or year) are used, this function is called to get event data. Arguments are the calendar views which are either month or agendaWeek.
  47  Desc:
  48  Return JSON example:
  49 [{"event_description":"N/A","end_drag":"2015-10-28T00:00:00","event_url":"#","allDay":1,"end_display":"2015-10-28","project_id":89,"property":"Planting Event","p_description":"Plants assayed at Zaria in 2002/03","cvterm_url":"/cvterm/76941/view","start_drag":"2015-10-28T00:00:00","end":"2015-10-29T00:00:00","start_display":"2015-10-28","projectprop_id":2735,"cvterm_id":76941,"title":"Cassava Zaria 2002/03","project_url":"/breeders_toolbox/trial/89/","start":"2015-10-28T00:00:00"},{"event_description":"N/A","end_drag":"2015-10-23T00:00:00","event_url":"#","allDay":1,"end_display":"2015-10-23","project_id":599,"property":"Presentation Event","p_description":"Test Bootstrap2","cvterm_url":"/cvterm/76946/view","start_drag":"2015-10-22T00:00:00","end":"2015-10-24T00:00:00","start_display":"2015-10-22","projectprop_id":2729,"cvterm_id":76946,"title":"TestBootstrap2","project_url":"/breeders_toolbox/trial/599/","start":"2015-10-22T00:00:00"}]
  50  Args: The calendar view being displayed, either month or agendaWeek
  51  Side Effects:
  52  Example:
  53
  54 =cut
  55
  56
  57 sub calendar_events_personal  : Path('/ajax/calendar/populate/personal') : ActionClass('REST') { }
  58 sub calendar_events_personal_GET : Args(1) {
  59     my $self = shift;
  60     my $c = shift;
  61     my $view = shift;
  62     if (!$c->user()) {$c->detach();}
  63     my $schema = $c->dbic_schema('Bio::Chado::Schema', 'sgn_chado');
  64     my @roles = $c->user->get_roles();
  65
  66     my $calendar_funcs = CXGN::Calendar->new({
  67         bcs_schema => $schema,
  68         sp_person_id => $c->user->get_object->get_sp_person_id,
  69         roles => \@roles
  70     });
  71     my $search_rs = $calendar_funcs->get_calendar_events_personal($c);
  72     $c->stash->{rest} = $calendar_funcs->populate_calendar_events($search_rs, $view);
  73 }
  74
  75 =head2 /ajax/calendar/drag_or_resize
  76
  77  Usage: When an event is added using the day_dialog_add_event_form, this function is called to save it to the database.
  78  Desc:
  79  Return JSON example:
  80  Args: event_start, event_end, event_description, event_url, event_project_select, event_type_select
  81  Side Effects:
  82  Example:
  83
  84 =cut
  85
  86 sub add_event : Path('/ajax/calendar/add_event') : ActionClass('REST') { }
  87 sub add_event_POST {
  88     my $self = shift;
  89     my $c = shift;
  90     my $params = $c->req->params();
  91
  92     if (!($c->user()->check_roles('curator') || $c->user()->check_roles('submitter')) ) {
  93         $c->stash->{rest} = {status => 3};
  94         return;
  95     }
  96
  97     my $calendar_funcs = CXGN::Calendar->new({});
  98
  99     #A time::piece object is returned from format_time(). Calling ->datetime on this object return an ISO8601 datetime string. This is what is saved in the db.
 100     my $format_start = $calendar_funcs->format_time($params->{event_start})->datetime;
 101
 102     #If an event end is given, then it is converted to an ISO8601 datetime string to be saved. If none is given then the end will be the same as the start.
 103     my $format_end;
 104     if ($params->{event_end} eq '') {$format_end = $format_start;} else {$format_end = $calendar_funcs->format_time($params->{event_end})->datetime;}
 105
 106     #If no description or URL given, then default values will be given.
 107     if ($params->{event_description} eq '') {$params->{event_description} = 'N/A';}
 108     if ($params->{event_url} eq '') {$params->{event_url} = '#';} else {$params->{event_url} = 'http://www.'.$params->{event_url};}
 109
 110     my $schema = $c->dbic_schema('Bio::Chado::Schema');
 111     my $rs = $schema->resultset('Project::Projectprop');
 112     my $count = $rs->search({ project_id=>$params->{event_project_select}, type_id=>$params->{event_type_select} })->count;
 113
 114     if (my $insert = $rs->create({project_id=>$params->{event_project_select}, type_id=>$params->{event_type_select}, rank=>$count, value=>[$format_start, $format_end, $params->{event_description}, $params->{event_url}] })) {
 115            $c->stash->{rest} = {status => 1,};
 116     } else {
 117            $c->stash->{rest} = {status => 2,};
 118     }
 119 }
 120
 121 =head2 /ajax/calendar/delete_event
 122
 123  Usage: To delete an event
 124  Desc:
 125  Return JSON example:
 126  Args: event_projectprop_id
 127  Side Effects:
 128  Example:
 129
 130 =cut
 131
 132 sub delete_event : Path('/ajax/calendar/delete_event') : ActionClass('REST') { }
 133 sub delete_event_POST {
 134     my $self = shift;
 135     my $c = shift;
 136
 137     if (!($c->user()->check_roles('curator') || $c->user()->check_roles('submitter')) ) {
 138         $c->stash->{rest} = {status => 3};
 139         return;
 140     }
 141
 142     my $projectprop_id = $c->req->param("event_projectprop_id");
 143     my $schema = $c->dbic_schema('Bio::Chado::Schema');
 144     if (my $delete = $schema->resultset('Project::Projectprop')->find({projectprop_id=>$projectprop_id})->delete) {
 145            $c->stash->{rest} = {status => 1,};
 146     } else {
 147            $c->stash->{rest} = {status => 0,};
 148     }
 149 }
 150
 151 =head2 /ajax/calendar/drag_or_resize
 152
 153  Usage: When an event is dragged to a new date a value of drag = 1 is passed to the function. When an event is simply resized a value of drag = 0 is passed to the function. This function saves the new start and end date to the db and updates the calendar display and mouseover.
 154  Desc:
 155  Return JSON example:
 156  Args: start_drag, delta, end_drag, drag, view, allday, projectprop_id, description, url
 157  Side Effects:
 158  Example:
 159
 160 =cut
 161
 162 sub drag_or_resize_event : Path('/ajax/calendar/drag_or_resize') : ActionClass('REST') { }
 163 sub drag_or_resize_event_POST {
 164     my $self = shift;
 165     my $c = shift;
 166     my $params = $c->req->params();
 167
 168     if (!($c->user()->check_roles('curator') || $c->user()->check_roles('submitter')) ) {
 169         $c->stash->{rest} = {status => 3};
 170         return;
 171     }
 172
 173     my $calendar_funcs = CXGN::Calendar->new({});
 174
 175     #First we process the start datetime.
 176     #A time::piece object is returned from format_time(). Delta is the number of seconds that the date was changed. Calling ->epoch on the time::piece object returns a string representing number of sec since epoch.
 177     my $formatted_start = $calendar_funcs->format_time($params->{start_drag} )->epoch;
 178
 179     #If the event is being dragged to a new start, then the delta is added to the start here. When resizing, the start is not changed, only the end is changed.
 180     if ($params->{drag} == 1) {
 181         $formatted_start += $params->{delta};
 182     }
 183
 184     #The string representing the new number of sec since epoch is parsed into a time::piece object.
 185     $formatted_start = Time::Piece->strptime($formatted_start, '%s');
 186
 187     # $new_start is what is saved to db. $new_start_display is what is displayed on mouseover.
 188     my $new_start = $formatted_start->datetime;
 189     my $new_start_display = $calendar_funcs->format_display_date($formatted_start);
 190
 191     #Next we process the end datetime. Whether the event is being dragged or resized, the end = end + delta.
 192     my $formatted_end = $calendar_funcs->format_time($params->{end_drag} )->epoch;
 193     $formatted_end += $params->{delta};
 194     $formatted_end = Time::Piece->strptime($formatted_end, '%s');
 195
 196     # $new_end is what is saved in db.
 197     my $new_end = $formatted_end->datetime;
 198     my $new_end_time = $calendar_funcs->calendar_end_display($formatted_end, $params->{view}, $params->{allday} );
 199     my $new_end_display = $calendar_funcs->format_display_date($formatted_end);
 200
 201     my $schema = $c->dbic_schema('Bio::Chado::Schema');
 202     if (my $update_rs = $schema->resultset('Project::Projectprop')->find({projectprop_id=>$params->{projectprop_id} }, columns=>['value'])->update({value=>[$new_start, $new_end, $params->{description}, $params->{url}] })) {
 203
 204            $c->stash->{rest} = {success => 1, start=>$new_start, start_drag=>$new_start, start_display=>$new_start_display, end=>$new_end_time, end_drag=>$new_end, end_display=>$new_end_display};
 205     } else {
 206            $c->stash->{rest} = {error => 1,};
 207     }
 208 }
 209
 210 =head2 /ajax/calendar/edit_event
 211
 212  Usage: When an event is editted using the edit_event_form
 213  Desc:
 214  Return JSON example:
 215  Args: edit_event_start, edit_event_end, edit_event_description, edit_event_url, edit_event_projectprop_id, edit_event_project_select, edit_event_type_select
 216  Side Effects:
 217  Example:
 218
 219 =cut
 220
 221 sub edit_event : Path('/ajax/calendar/edit_event') : ActionClass('REST') { }
 222 sub edit_event_POST {
 223     my $self = shift;
 224     my $c = shift;
 225
 226     if (!($c->user()->check_roles('curator') || $c->user()->check_roles('submitter')) ) {
 227         $c->stash->{rest} = {status => 3};
 228         return;
 229     }
 230
 231     my $params = $c->req->params();
 232     my $calendar_funcs = CXGN::Calendar->new({});
 233
 234     #A time::piece object is returned from format_time(). Calling ->datetime on this object return an ISO8601 datetime string. This is what is saved in the db.
 235     my $format_start = $calendar_funcs->format_time($params->{edit_event_start})->datetime;
 236
 237     #If an event end is given, then it is converted to an ISO8601 datetime string to be saved. If none is given then the end will be the same as the start.
 238     my $format_end;
 239     if ($params->{edit_event_end} eq '') {$format_end = $format_start;} else {$format_end = $calendar_funcs->format_time($params->{edit_event_end})->datetime;}
 240
 241     #If no description or URL given or end date given, then default values will be given.
 242     if ($params->{edit_event_description} eq '') {$params->{edit_event_description} = 'N/A';}
 243     if ($params->{edit_event_url} eq '') {$params->{edit_event_url} = '#';}
 244
 245     my $schema = $c->dbic_schema('Bio::Chado::Schema');
 246     if (my $update_rs = $schema->resultset('Project::Projectprop')->find({projectprop_id=>$params->{edit_event_projectprop_id} }, columns=>['project_id', 'type_id', 'value'])->update({project_id=>$params->{edit_event_project_select}, type_id=>$params->{edit_event_type_select}, value=>[$format_start, $format_end, $params->{edit_event_description}, $params->{edit_event_url}] })) {
 247            $c->stash->{rest} = {status => 1,};
 248     } else {
 249            $c->stash->{rest} = {error => 1,};
 250     }
 251 }
 252
 253
 254 #When a day is clicked or when an event is being editted, this function is called to populate the add_event project name and property type dropdowns.
 255 sub day_click_personal : Path('/ajax/calendar/dayclick/personal') : ActionClass('REST') { }
 256 sub day_click_personal_GET {
 257     my $self = shift;
 258     my $c = shift;
 259
 260     my $person_id = $c->user->get_object->get_sp_person_id;
 261
 262     my @roles = $c->user->get_roles();
 263     my @projects;
 264     foreach (@roles) {
 265         my $q="SELECT project_id, name FROM project WHERE name=?";
 266         my $sth = $c->dbc->dbh->prepare($q);
 267         $sth->execute($_);
 268         while (my ($project_id, $name) = $sth->fetchrow_array ) {
 269             push(@projects, {project_id=>$project_id, project_name=>$name});
 270
 271             my $q="SELECT subject_project_id, project.name FROM project_relationship JOIN cvterm ON (type_id=cvterm_id) JOIN project ON (subject_project_id=project_id) WHERE object_project_id=? and cvterm.name='breeding_program_trial_relationship'";
 272             my $sth = $c->dbc->dbh->prepare($q);
 273             $sth->execute($project_id);
 274             while (my ($trial_id, $trial_name) = $sth->fetchrow_array ) {
 275                 push(@projects, {project_id=>$trial_id, project_name=>$trial_name});
 276             }
 277         }
 278     }
 279
 280     my @calendar_projectprop_names = (['project_planting_date', 'project_property'], ['project_harvest_date', 'project_property'], ['Fertilizer Event', 'calendar'], ['Meeting Event', 'calendar'], ['Planning Event', 'calendar'], ['Presentation Event', 'calendar'], ['Phenotyping Event', 'calendar'], ['Genotyping Event', 'calendar'] );
 281
 282     my $schema = $c->dbic_schema('Bio::Chado::Schema');
 283     my @projectprop_types;
 284     foreach (@calendar_projectprop_names) {
 285         my $term = SGN::Model::Cvterm->get_cvterm_row($schema, $_->[0], $_->[1] );
 286         if ($term) {
 287             push(@projectprop_types, {cvterm_id=>$term->cvterm_id(), cvterm_name=>$term->name() });
 288         } else {
 289             push(@projectprop_types, {cvterm_id=>'', cvterm_name=>'Error: Missing cvterm '.$_->[0].' : '.$_->[1].' in database.'});
 290         }
 291     }
 292
 293     $c->stash->{rest} = {project_list => \@projects, projectprop_list => \@projectprop_types};
 294 }
 295
 296
 297 1;