Open-ILS/src/perlmods/OpenILS/Application/Actor/Friends.pm

   1 package OpenILS::Application::Actor::Friends;
   2 use strict; use warnings;
   3 use OpenILS::Application::AppUtils;
   4 use OpenILS::Utils::CStoreEditor q/:funcs/;
   5 use OpenSRF::Utils::Logger q/$logger/;
   6 use OpenILS::Utils::Fieldmapper;
   7 my $U = "OpenILS::Application::AppUtils";
   8
   9 # ----------------------------------------------------------------
  10 # Shared Friend utilities.  Thar be no methods published here...
  11 # ----------------------------------------------------------------
  12
  13 # export these fields for friend display
  14 my @keep_user_fields = qw/id usrname first_given_name second_given_name family_name alias/;
  15
  16 my $out_links_query = {
  17     select => {cubi => ['target_user']},
  18     from => {
  19         cub => {
  20             cubi => {field => 'bucket', fkey => 'id'}
  21         }
  22     },
  23     where => {
  24         '+cub' => {btype => 'folks', owner => undef}
  25     }
  26 };
  27
  28 my $in_links_query = {
  29     select => {cub =>  ['owner'] },
  30     from => {
  31         cub => {
  32             cubi => {field => 'bucket', fkey => 'id'}
  33         }
  34     },
  35     where => {
  36         '+cubi' => {target_user => undef},
  37         '+cub' => {btype => 'folks'}
  38     }
  39 };
  40
  41 my $perm_check_query = {
  42     select => {cub =>  ['btype'] },
  43     from => {
  44         cub => {
  45             cubi => {field => 'bucket', fkey => 'id'}
  46         }
  47     },
  48     limit => 1
  49 };
  50
  51 sub retrieve_friends {
  52     my($self, $e, $user_id, $options) = @_;
  53     $options ||= {};
  54
  55     # users I have links to
  56     $out_links_query->{where}->{'+cub'}->{owner} = $user_id;
  57     my @out_linked = map {$_->{target_user}} @{$e->json_query($out_links_query)};
  58
  59     # users who link to me
  60     $in_links_query->{where}->{'+cubi'}->{target_user} = $user_id;
  61     my @in_linked = map {$_->{owner}} @{$e->json_query($in_links_query)};
  62
  63     # determine which users are confirmed, pending outbound
  64     # requests, and pending inbound requests
  65     my @confirmed;
  66     my @pending_out;
  67     my @pending_in;
  68
  69     for my $out_link (@out_linked) {
  70         if(grep {$_ == $out_link} @in_linked) {
  71             push(@confirmed, $out_link);
  72         } else {
  73             push(@pending_out, $out_link);
  74         }
  75     }
  76
  77     for my $in_link (@in_linked) {
  78         push(@pending_in, $in_link)
  79             unless grep {$_ == $in_link} @confirmed;
  80     }
  81
  82     if($$options{confirmed_only}) {
  83         return {
  84             confirmed => $self->load_linked_user_perms($e, $user_id, @confirmed),
  85         };
  86     } else {
  87         return {
  88             confirmed => $self->load_linked_user_perms($e, $user_id, @confirmed),
  89             pending_out => $self->load_linked_user_perms($e, $user_id, @pending_out),
  90             pending_in => $self->load_linked_user_perms($e, $user_id, @pending_in)
  91         };
  92     }
  93 }
  94
  95 # given a base user and set of linked users, returns the trimmed linked user
  96 # records, plus the perms (by name) each user has been granted
  97 sub load_linked_user_perms {
  98     my($self, $e, $user_id, @users) = @_;
  99     my $items = [];
 100     my $select = {select => {au => \@keep_user_fields}};
 101
 102     for my $d_user (@users) {
 103
 104         # fetch all of the bucket items linked from base user to
 105         # delegate user with the folks: prefix on the bucket type
 106         $perm_check_query->{where} = {
 107             '+cubi' => {target_user => $d_user},
 108             '+cub' => {btype => {like => 'folks:%'}, owner => $user_id}
 109         };
 110
 111         push(@$items, {
 112                 user => $e->retrieve_actor_user([$d_user, $select]),
 113                 permissions => [
 114                     # trim the folks: prefix from the bucket type
 115                     map {substr($_->{btype}, 6)} @{$e->json_query($perm_check_query)}
 116                 ]
 117             }
 118         );
 119     }
 120     return $items;
 121 }
 122
 123
 124 my $direct_links_query = {
 125     select => {cub =>  ['id'] },
 126     from => {
 127         cub => {
 128             cubi => {field => 'bucket', fkey => 'id'}
 129         }
 130     },
 131     where => {
 132         '+cubi' => {target_user => undef},
 133         '+cub' => {btype => 'folks', owner => undef}
 134     },
 135     limit => 1
 136 };
 137
 138 sub confirmed_friends {
 139     my($self, $e, $user1_id, $user2_id) = @_;
 140
 141     $direct_links_query->{where}->{'+cub'}->{owner} = $user1_id;
 142     $direct_links_query->{where}->{'+cubi'}->{target_user} = $user2_id;
 143
 144     if($e->json_query($direct_links_query)->[0]) {
 145
 146         $direct_links_query->{where}->{'+cub'}->{owner} = $user2_id;
 147         $direct_links_query->{where}->{'+cubi'}->{target_user} = $user1_id;
 148         return 1 if $e->json_query($direct_links_query)->[0];
 149     }
 150
 151     return 0;
 152 }
 153
 154
 155
 156 # returns 1 if delegate_user is allowed to perform 'perm' for base_user
 157 sub friend_perm_allowed {
 158     my($self, $e, $base_user_id, $delegate_user_id, $perm) = @_;
 159     return 0 unless $self->confirmed_friends($base_user_id, $delegate_user_id);
 160     $perm_check_query->{where} = {
 161         '+cubi' => {target_user => $delegate_user_id},
 162         '+cub' => {btype => "folks:$perm", owner => $base_user_id}
 163     };
 164     return 1 if $e->json_query($perm_check_query)->[0];
 165     return 0;
 166 }
 167
 168 sub apply_friend_perm {
 169     my($self, $e, $base_user_id, $delegate_user_id, $perm) = @_;
 170
 171     my $bucket = $e->search_container_user_bucket(
 172         {owner => $base_user_id, btype => "folks:$perm"})->[0];
 173
 174     if($bucket) {
 175         # is the permission already set?
 176         return undef if $e->search_container_user_bucket_item(
 177             {bucket => $bucket->id, target_user => $delegate_user_id})->[0];
 178
 179     } else {
 180         # make sure the perm-specific bucket exists for this user
 181         $bucket = Fieldmapper::container::user_bucket->new;
 182         $bucket->owner($base_user_id);
 183         $bucket->btype("folks:$perm");
 184         $bucket->name("folks:$perm");
 185         $e->create_container_user_bucket($bucket) or return $e->die_event;
 186     }
 187
 188     my $item = Fieldmapper::container::user_bucket_item->new;
 189     $item->bucket($bucket->id);
 190     $item->target_user($delegate_user_id);
 191     $e->create_container_user_bucket_item($item) or return $e->die_event;
 192     return undef;
 193 }
 194
 195 23;