MicrosubController.php

<?php
namespace App\Http\Controllers;

use Request, Response, DB, Log, Auth;
use App\Events\SourceAdded, App\Events\SourceRemoved;
use App\User, App\Source, App\Channel, App\Entry, App\ChannelToken;
use p3k\XRay;

class MicrosubController extends Controller
{
  private static function _actions() {
    return [
      'timeline' => 'read',
      'follow' => 'follow',
      'unfollow' => 'follow',
      'mute' => 'mute',
      'unmute' => 'mute',
      'block' => 'block',
      'unblock' => 'block',
      'read-channels' => 'read',
      'write-channels' => 'channels',
      'search' => '',
      'preview' => '',
    ];
  }

  private function _verifyScopeForAction($action) {
    $expect = self::_actions()[$action];
    if($expect) {
      $tokenData = Request::get('token_data');
      if(isset($tokenData['scope']) && is_array($tokenData['scope']))
        return in_array($expect, $tokenData['scope']);
      else
        return false;
    }
    else
      return true;
  }

  private function _verifyAction($action) {
    $actions = self::_actions();
    if(!array_key_exists($action, $actions)) {
      return Response::json([
        'error' => 'bad_request',
        'error_description' => 'This operation is not supported'
      ], 400);
    }
    return true;
  }

  private function _getRequestChannel() {
    // For channel tokens, force the request channel to the channel defined in the token
    $td = Request::get('token_data');
    if(isset($td['type']) && $td['type'] == 'channel') {
      return Channel::where('id', $td['channel_id'])->first();
    } else {
      if(!Request::input('channel')) {
        return Response::json([
          'error' => 'invalid_input',
          'error_description' => 'No channel specified'
        ], 400);
      }

      $uid = Request::input('channel');
      $channel = Channel::where('user_id', Auth::user()->id)->where('uid', $uid)->first();
      if(!$channel)
        return Response::json([
          'error' => 'not_found',
          'error_description' => 'Channel not found'
        ], 404);
      else
        return $channel;
    }
  }

  public function get(Request $request) {
    $token_data = Request::get('token_data');

    $action = Request::input('action');

    switch($action) {
        // Any items that have a different read/write scope, should be added as cases
        case 'channels':
            $scopeKey = 'read-'.$action;
            break;
        default:
            $scopeKey = $action;
    }

    $verify = $this->_verifyAction($scopeKey);
    if($verify !== true)
      return $verify;

    if(!method_exists($this, 'get_'.$action))
      return Response::json([
        'error' => 'not_implemented',
        'error_description' => 'This method has not yet been implemented'
      ], 400);

    if(!$this->_verifyScopeForAction($scopeKey)) {
      return Response::json([
        'error' => 'unauthorized',
        'error_description' => 'The access token provided does not have the necessary scope for this action',
      ], 401);
    }

    return $this->{'get_'.$action}();
  }

  public function post(Request $request) {
    $token_data = Request::get('token_data');

    $action = Request::input('action');

    switch($action) {
      // Any items that have a different read/write scope, should be added as cases
      case 'channels':
          $scopeKey = 'write-'.$action;
          break;
      default:
          $scopeKey = $action;
    }

    $verify = $this->_verifyAction($scopeKey);
    if($verify !== true)
      return $verify;

    if(!method_exists($this, 'post_'.$action))
      return Response::json([
        'error' => 'not_implemented',
        'error_description' => 'This method has not yet been implemented'
      ], 400);

    if(!$this->_verifyScopeForAction($scopeKey)) {
      return Response::json([
        'error' => 'unauthorized',
        'error_description' => 'The access token provided does not have the necessary scope for this action',
      ], 401);
    }

    return $this->{'post_'.$action}();
  }

  //////////////////////////////////////////////////////////////////////////////////

  private function get_channels() {
    $channels = [];

    foreach(Auth::user()->channels()->get() as $channel) {
      $channels[] = $channel->to_array();
    }

    return [
      'channels' => $channels
    ];
  }

  private function post_channels() {
    if(Request::input('method') == 'delete') {
      // Delete

      if(!Request::input('channel')) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'Missing channel parameter'], 400);
      }

      if(in_array(Request::input('channel'), ['notifications','global'])) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'Cannot delete system channels'], 400);
      }

      $channel = Auth::user()->channels()->where('uid', Request::input('channel'))->first();

      if(!$channel) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'Channel not found'], 400);
      }

      $channel->entries()->delete();
      $channel->delete();

      return Response::json(['deleted' => true]);

    } elseif(Request::input('method') == 'order') {
      // Set Channel Order

      if(!Request::input('channels')) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'Missing channels parameter'], 400);
      }

      if(!is_array(Request::input('channels'))) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'channels parameter must be an array'], 400);
      }

      $inputChannels = Request::input('channels');

      $sorted = Auth::user()->set_channel_order($inputChannels);

      if(!$sorted) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'One or more channels were not found'], 400);
      }

      return Response::json(['channels' => $sorted]);

    } elseif(Request::input('channel')) {
      // Update

      if(!Request::input('channel')) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'Missing channel parameter'], 400);
      }

      if(in_array(Request::input('channel'), ['notifications','global'])) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'Cannot rename system channels'], 400);
      }

      $channel = Auth::user()->channels()->where('uid', Request::input('channel'))->first();

      if(!$channel) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'Channel not found'], 400);
      }

      if(Request::input('name')) {
        $channel->name = Request::input('name');
        $channel->save();
      }

      return Response::json($channel->to_array());

    } else {
      // Create

      if(!trim(Request::input('name'))) {
        return Response::json(['error' => 'invalid_input', 'error_description' => 'Missing name parameter'], 400);
      }

      $channels = [];
      foreach(Auth::user()->channels()->get() as $channel) {
        $channels[] = $channel->name;
      }

      if(in_array(Request::input('name'), $channels)) {
        return Response::json(['error' => 'duplicate'], 400);
      }

      $channel = Auth::user()->create_channel(Request::input('name'));

      return Response::json($channel->to_array());
    }
  }

  private function post_search() {
    if(Request::input('channel') == null) {
      // Search for feeds matching the query

      if(!Request::input('query')) {
        return Response::json(['error' => 'invalid_query'], 400);
      }

      // The query might be:
      // * a full URL
      // * a term that could be normalized to a URL (e.g. "example.com")
      // * a generic term

      $url = false;
      $query = Request::input('query');

      if(\p3k\url\is_url($query)) {
        // Directly entered URL including scheme
        $url = \p3k\url\normalize($query);
      } else {
        if(preg_match('/^[a-z][a-z0-9]+$/', $query)) {
          // if just a word was entered, append .com
          $possible_url = $query . '.com';
        } else {
          $possible_url = $query;
        }
        // Possible URL that may require adding a scheme
        $possible_url = \p3k\url\normalize($possible_url);
        // Check if the hostname has at least one dot
        if(strpos(parse_url($possible_url, PHP_URL_HOST), '.') !== false) {
          $url = $possible_url;
        }
      }

      $http = new \p3k\HTTP();
      $http->set_user_agent(env('USER_AGENT'));
      $http->timeout = 4;

      $xray = new \p3k\XRay();
      $xray->http = $http;
      $response = $xray->feeds($url);

      $feeds = [];

      if(!isset($response['error']) && $response['code'] == 200) {
        $feeds = $response['feeds'];
      }

      foreach($feeds as $i=>$feed) {
        $feeds[$i]['type'] = 'feed';
      }

      // TODO: also search existing feeds in the database that may be indexed


      return Response::json([
        'results' => $feeds
      ]);
    } else {
      // TODO: Search within channels for posts matching the query

      return Response::json([
        'error' => 'not_implemented'
      ], 400);
    }
  }

  private function get_preview() {
    // If the feed is already in the database, return those results
    $source = Source::where('url', Request::input('url'))->first();

    $items = [];

    if($source) {
      $entries = $source->entries()
        ->select('entries.*')
        ->orderByDesc('created_at')
        ->orderByDesc('published')
        ->limit(20)
        ->get();

      foreach($entries as $entry) {
        $items[] = $entry->to_array();
      }
    } else {
      // Fetch the feed and return the first results
      $http = new \p3k\HTTP();
      $http->set_user_agent(env('USER_AGENT'));
      $http->timeout = 4;

      $xray = new \p3k\XRay();
      $xray->http = $http;
      $parsed = $xray->parse(Request::input('url'), ['expect'=>'feed']);

      if($parsed && isset($parsed['data']['type']) && $parsed['data']['type'] == 'feed') {
        $items = $parsed['data']['items'];
      }
    }

    $response = [
      'items' => $items
    ];
    return Response::json($response);
  }

  private function get_timeline() {
    $channel = $this->_getRequestChannel();

    // Check that the channel exists
    if(get_class($channel) != Channel::class)
      return $channel;

    $limit = ((int)Request::input('limit')) ?: 20;

    $entries = $channel->entries()
      ->select('entries.*', 'channel_entry.created_at AS added_to_channel_at', 'channel_entry.batch_order')
      ->orderByDesc('channel_entry.created_at')
      ->orderBy('channel_entry.batch_order')
      ->limit($limit+1); // fetch 1 more than the limit so we know if we've reached the end

    // Return items in a particular source
    if(Request::input('source')) {
      $source_id = (int)Request::input('source');
      $entries = $entries->where('source_id', $source_id);
    }

    if(Request::input('before')) {
      if(!($before=$this->_parseEntryCursor(Request::input('before')))) {
        return Response::json(['error' => 'invalid_cursor'], 400);
      }

      $entries = $entries->where(function($query) use($before){
        $query->where('channel_entry.created_at', '>', $before[0])
          ->orWhere(function($query) use($before) {
            $query->where('channel_entry.created_at', '=', $before[0])
              ->where('channel_entry.batch_order', '<', $before[1]);
          });
        });
    }

    if(Request::input('after')) {
      if(!($after=$this->_parseEntryCursor(Request::input('after')))) {
        return Response::json(['error' => 'invalid_cursor'], 400);
      }

      $entries = $entries->where(function($query) use($after){
        $query->where('channel_entry.created_at', '<', $after[0])
          ->orWhere(function($query) use($after) {
            $query->where('channel_entry.created_at', '=', $after[0])
              ->where('channel_entry.batch_order', '>=', $after[1]);
          });
        });
    }

    if(Request::input('is_read') == 'false') {
      $entries = $entries->where('seen', 0);
    }

    #Log::info('timeline request: before='.Request::input('before').' after='.Request::input('after'));

    $entries = $entries->get();

    $newbefore = false;
    $newafter = false;
    $items = [];
    foreach($entries as $i=>$entry) {
      if($i == 0) // Always include a cursor to be able to return newer entries
        $newbefore = $this->_buildEntryCursor($entry);

      if($i < $limit)
        $items[] = $entry->to_array($channel);

      if($i == $limit) // Don't add the last item, but return a cursor for the next page
        $newafter = $this->_buildEntryCursor($entry);
    }

    $response = [
      'items' => $items,
      'paging' => []
    ];

    if(Request::input('source')) {
      $source = Source::where('id', (int)Request::input('source'))->first();
      $response['source'] = $source->to_array();
    }

    if($newbefore && $newbefore != Request::input('after'))
      $response['paging']['before'] = $newbefore;

    if($newafter)
      $response['paging']['after'] = $newafter;

    #Log::info('new paging: '.json_encode($response['paging']));

    if(count($response['paging']) == 0) {
      $response['paging'] = new \stdClass;
    }

    return Response::json($response);
  }

  private function post_timeline() {
    $channel = $this->_getRequestChannel();

    // Check that the channel exists
    if(get_class($channel) != Channel::class)
      return $channel;

    switch(Request::input('method')) {
      case 'mark_read':

        if(Request::input('last_read_entry')) {

          $channel_entry = DB::table('channel_entry')
            ->where('channel_id', $channel->id)
            ->where('entry_id', Request::input('last_read_entry'))
            ->first();

          if(!$channel_entry) {
            return Response::json(['error' => 'invalid_input', 'error_description' => 'The entry ID provided was not found'], 400);
          }

          $entry = Entry::where('id', $channel_entry->entry_id)->first();

          $result = $channel->mark_entries_read_before($entry, $channel_entry);

          return Response::json(['result' => 'ok', 'updated' => $result]);

        } elseif(Request::input('entry')) {

          if(!is_array(Request::input('entry'))) {
            $entryIds = [Request::input('entry')];
          } else {
            $entryIds = Request::input('entry');
          }

          $result = $channel->mark_entries_read($entryIds);

          return Response::json(['result' => 'ok', 'updated' => $result]);

        } else {
          return Response::json(['error' => 'invalid_input', 'error_description' => 'To mark one or more entries as read, include an entry id or last_read_entry parameter'], 400);
        }

      case 'mark_unread':

        if(Request::input('entry')) {

          if(!is_array(Request::input('entry'))) {
            $entryIds = [Request::input('entry')];
          } else {
            $entryIds = Request::input('entry');
          }

          $result = $channel->mark_entries_unread($entryIds);

          return Response::json(['result' => 'ok', 'updated' => $result]);

        } else {
          return Response::json(['error' => 'invalid_input', 'error_description' => 'To mark one or more entries as unread, include an entry id'], 400);
        }

      case 'remove':

        if(Request::input('entry')) {

          if(!is_array(Request::input('entry'))) {
            $entryIds = [Request::input('entry')];
          } else {
            $entryIds = Request::input('entry');
          }

          $result = $channel->remove_entries($entryIds);

          return Response::json(['result' => 'ok', 'updated' => $result]);

        } else {
          return Response::json(['error' => 'invalid_input', 'error_description' => 'To mark one or more entries as unread, include an entry id'], 400);
        }


      default:
        return Response::json(['error' => 'invalid_method', 'error_description' => 'The specified method was not found for this action'], 400);
    }
  }

  private function get_follow() {
    $channel = $this->_getRequestChannel();

    if(get_class($channel) != Channel::class)
      return $channel;

    $following = [];

    $sources = $channel->sources()
      ->where('url', '!=', '')
      ->get();

    foreach($sources as $s) {
      $feed = [
        'type' => 'feed',
        'url' => $s->url
      ];

      if($s->pivot->name)
        $feed['name'] = $s->pivot->name;

      $following[] = $feed;
    }

    return [
      'items' => $following
    ];
  }

  private function post_follow() {
    $channel = $this->_getRequestChannel();

    if(get_class($channel) != Channel::class)
      return $channel;

    $source = Source::where('url', Request::input('url'))->first();

    if(!$source) {
      $source = new Source;
      $source->created_by = Auth::user()->id;
      $source->url = Request::input('url');
      $source->token = str_random(32);
      $source->is_new = true;
      $source->save();
    }

    if($channel->sources()->where('source_id', $source->id)->count() == 0)
      $channel->sources()->attach($source->id, ['created_at'=>date('Y-m-d H:i:s')]);

    event(new SourceAdded($source, $channel));

    return [
      'type' => 'feed',
      'url' => $source->url
    ];
  }

  private function post_unfollow() {
    $channel = $this->_getRequestChannel();

    if(get_class($channel) != Channel::class)
      return $channel;

    $source = Source::where('url', Request::input('url'))->first();

    if(!$source) {
      return '';
    }

    $channel->remove_source($source);

    return [
      'type' => 'feed',
      'url' => $source->url
    ];
  }
}