Allow specifying the location of the twitter oauth and pocket oauth files. This shoul...
[rainbowstream.git] / rainbowstream / rainbow.py
index a2c80e7711218bb9d1cf60079654841e0714fe24..187fc452b168419d982ba90e280890ceed618036 100644 (file)
@@ -11,6 +11,7 @@ import traceback
 import pkg_resources
 import socks
 import socket
+import re
 
 from io import BytesIO
 from twitter.stream import TwitterStream, Timeout, HeartbeatTimeout, Hangup
@@ -19,6 +20,8 @@ from twitter.oauth import OAuth, read_token_file
 from twitter.oauth_dance import oauth_dance
 from twitter.util import printNicely
 
+from pocket import Pocket
+
 from .draw import *
 from .colors import *
 from .config import *
@@ -44,7 +47,7 @@ def parse_arguments():
     parser.add_argument(
         '-s',
         '--stream',
-             default="mine",
+        default="mine",
         help='Default stream after program start. (Default: mine)')
     parser.add_argument(
         '-to',
@@ -67,6 +70,11 @@ def parse_arguments():
         '--image-on-term',
         action='store_true',
         help='Display all image on terminal.')
+    parser.add_argument(
+        '-24',
+        '--color-24bit',
+        action='store_true',
+        help='Display images using 24bit color codes.')
     parser.add_argument(
         '-ph',
         '--proxy-host',
@@ -81,6 +89,16 @@ def parse_arguments():
         '--proxy-type',
         default='SOCKS5',
         help='Proxy type (HTTP, SOCKS4, SOCKS5; Default: SOCKS5).')
+    parser.add_argument(
+        '-ta',
+        '--twitter-auth',
+        default=os.environ.get('HOME', os.environ.get('USERPROFILE', '')) + os.sep + '.rainbow_oauth',
+        help='Specify which OAuth profile to use for twitter. Default: ~/.rainbow_oauth.')
+    parser.add_argument(
+        '-pa',
+        '--pocket-auth',
+        default=os.environ.get('HOME', os.environ.get('USERPROFILE', '')) + os.sep + '.rainbow_pckt_oauth',
+        help='Specify which OAuth profile to use for pocket. Default: ~/.rainbow_pckt_oauth.')
     return parser.parse_args()
 
 
@@ -114,11 +132,7 @@ def authen():
     Authenticate with Twitter OAuth
     """
     # When using rainbow stream you must authorize.
-    twitter_credential = os.environ.get(
-        'HOME',
-        os.environ.get(
-            'USERPROFILE',
-            '')) + os.sep + '.rainbow_oauth'
+    twitter_credential = g['twitter_oauth_path']
     if not os.path.exists(twitter_credential):
         oauth_dance('Rainbow Stream',
                     CONSUMER_KEY,
@@ -132,6 +146,30 @@ def authen():
         CONSUMER_SECRET)
 
 
+def pckt_authen():
+    """
+    Authenticate with Pocket OAuth
+    """
+    pocket_credential = g['pocket_oauth_path']
+    if not os.path.exists(pocket_credential):
+        request_token = Pocket.get_request_token(consumer_key=PCKT_CONSUMER_KEY)
+        auth_url = Pocket.get_auth_url(code=request_token, redirect_uri="/")
+        webbrowser.open(auth_url)
+        printNicely(green("*** Press [ENTER] after authorization ***"))
+        raw_input()
+        user_credentials = Pocket.get_credentials(consumer_key=PCKT_CONSUMER_KEY, code=request_token)
+        access_token = user_credentials['access_token']
+        f = open(pocket_credential, 'w')
+        f.write(access_token)
+        f.close()
+    else:
+        with open(pocket_credential, 'r') as f:
+            access_token = str(f.readlines()[0])
+            f.close()
+
+    return Pocket(PCKT_CONSUMER_KEY, access_token)
+
+
 def build_mute_dict(dict_data=False):
     """
     Build muting list
@@ -176,19 +214,20 @@ def upgrade_center():
         url = 'https://raw.githubusercontent.com/DTVD/rainbowstream/master/setup.py'
         readme = requests.get(url).text
         latest = readme.split('version = \'')[1].split('\'')[0]
-        if current != latest:
+        g['using_latest'] = current == latest
+        if not g['using_latest']:
             notice = light_magenta('RainbowStream latest version is ')
             notice += light_green(latest)
             notice += light_magenta(' while your current version is ')
             notice += light_yellow(current) + '\n'
             notice += light_magenta('You should upgrade with ')
             notice += light_green('pip install -U rainbowstream')
-            printNicely(notice)
         else:
             notice = light_yellow('You are running latest version (')
             notice += light_green(current)
             notice += light_yellow(')')
-            printNicely(notice)
+            notice += '\n'
+        printNicely(notice)
     except:
         pass
 
@@ -200,6 +239,9 @@ def init(args):
     # Handle Ctrl C
     ctrl_c_handler = lambda signum, frame: quit()
     signal.signal(signal.SIGINT, ctrl_c_handler)
+    # Set OAuth file path (needs to happen before authen is called)
+    g['twitter_oauth_path'] = args.twitter_auth
+    g['pocket_oauth_path'] = args.pocket_auth
     # Upgrade notify
     upgrade_center()
     # Get name
@@ -233,7 +275,8 @@ def init(args):
     c['message_dict'] = []
     # Image on term
     c['IMAGE_ON_TERM'] = args.image_on_term
-    set_config('IMAGE_ON_TERM', str(c['IMAGE_ON_TERM']))
+    # Use 24 bit color
+    c['24BIT'] = args.color_24bit
     # Check type of ONLY_LIST and IGNORE_LIST
     if not isinstance(c['ONLY_LIST'], list):
         printNicely(red('ONLY_LIST is not a valid list value.'))
@@ -243,6 +286,8 @@ def init(args):
         c['IGNORE_LIST'] = []
     # Mute dict
     c['IGNORE_LIST'] += build_mute_dict()
+    # Pocket init
+    pckt = pckt_authen() if c['POCKET_SUPPORT'] else None
 
 
 def trend():
@@ -289,7 +334,9 @@ def home():
     num = c['HOME_TWEET_NUM']
     if g['stuff'].isdigit():
         num = int(g['stuff'])
-    for tweet in reversed(t.statuses.home_timeline(count=num)):
+    kwargs = {'count': num}
+    kwargs = add_tweetmode_parameter(kwargs)
+    for tweet in reversed(t.statuses.home_timeline(**kwargs)):
         draw(t=tweet)
     printNicely('')
 
@@ -314,7 +361,9 @@ def mentions():
     num = c['HOME_TWEET_NUM']
     if g['stuff'].isdigit():
         num = int(g['stuff'])
-    for tweet in reversed(t.statuses.mentions_timeline(count=num)):
+    kwargs = {'count': num}
+    kwargs = add_tweetmode_parameter(kwargs)
+    for tweet in reversed(t.statuses.mentions_timeline(**kwargs)):
         draw(t=tweet)
     printNicely('')
 
@@ -324,7 +373,11 @@ def whois():
     Show profile of a specific user
     """
     t = Twitter(auth=authen())
-    screen_name = g['stuff'].split()[0]
+    try:
+        screen_name = g['stuff'].split()[0]
+    except:
+        printNicely(red('Sorry I can\'t understand.'))
+        return
     if screen_name.startswith('@'):
         try:
             user = t.users.show(
@@ -343,20 +396,42 @@ def view():
     Friend view
     """
     t = Twitter(auth=authen())
-    user = g['stuff'].split()[0]
+    try:
+        user = g['stuff'].split()[0]
+    except:
+        printNicely(red('Sorry I can\'t understand.'))
+        return
     if user[0] == '@':
         try:
             num = int(g['stuff'].split()[1])
         except:
             num = c['HOME_TWEET_NUM']
-        for tweet in reversed(
-                t.statuses.user_timeline(count=num, screen_name=user[1:])):
+        kwargs = {'count': num, 'screen_name': user[1:]}
+        kwargs = add_tweetmode_parameter(kwargs)
+        for tweet in reversed(t.statuses.user_timeline(**kwargs)):
             draw(t=tweet)
         printNicely('')
     else:
         printNicely(red('A name should begin with a \'@\''))
 
 
+def view_my_tweets():
+    """
+    Display user's recent tweets.
+    """
+    t = Twitter(auth=authen())
+    try:
+        num = int(g['stuff'])
+    except:
+        num = c['HOME_TWEET_NUM']
+    kwargs = {'count': num, 'screen_name': g['original_name']}
+    kwargs = add_tweetmode_parameter(kwargs)
+    for tweet in reversed(
+            t.statuses.user_timeline(**kwargs)):
+        draw(t=tweet)
+    printNicely('')
+
+
 def search():
     """
     Search
@@ -364,17 +439,22 @@ def search():
     t = Twitter(auth=authen())
     # Setup query
     query = g['stuff'].strip()
+    if not query:
+        printNicely(red('Sorry I can\'t understand.'))
+        return
     type = c['SEARCH_TYPE']
     if type not in ['mixed', 'recent', 'popular']:
         type = 'mixed'
     max_record = c['SEARCH_MAX_RECORD']
     count = min(max_record, 100)
+    kwargs = {
+        'q': query,
+        'type': type,
+        'count': count,
+    }
+    kwargs = add_tweetmode_parameter(kwargs)
     # Perform search
-    rel = t.search.tweets(
-        q=query,
-        type=type,
-        count=count
-    )['statuses']
+    rel = t.search.tweets(**kwargs)['statuses']
     # Return results
     if rel:
         printNicely('Newest tweets:')
@@ -393,6 +473,55 @@ def tweet():
     t.statuses.update(status=g['stuff'])
 
 
+def pocket():
+    """
+    Add new link to Pocket along with tweet id
+    """
+    if not c['POCKET_SUPPORT']:
+        printNicely(yellow('Pocket isn\'t enabled.'))
+        printNicely(yellow('You need to "config POCKET_SUPPORT = true"'))
+        return
+
+    # Get tweet infos
+    p = pckt_authen()
+
+    t = Twitter(auth=authen())
+    try:
+        id = int(g['stuff'].split()[0])
+        tid = c['tweet_dict'][id]
+    except:
+        printNicely(red('Sorry I can\'t understand.'))
+        return
+
+    tweet = t.statuses.show(id=tid)
+
+    if len(tweet['entities']['urls']) > 0:
+        url = tweet['entities']['urls'][0]['expanded_url']
+    else:
+        url = "https://twitter.com/" + \
+                tweet['user']['screen_name'] + '/status/' + str(tid)
+
+    # Add link to pocket
+    try:
+        p.add(title=re.sub(r'(http:\/\/\S+)', r'', tweet['text']),
+            url=url,
+            tweet_id=tid)
+    except:
+        printNicely(red('Something is wrong about your Pocket account,'+ \
+                        ' please restart Rainbowstream.'))
+        pocket_credential = os.environ.get(
+            'HOME',
+            os.environ.get(
+                'USERPROFILE',
+                '')) + os.sep + '.rainbow_pckt_oauth'
+        if os.path.exists(pocket_credential):
+            os.remove(pocket_credential)
+        return
+
+    printNicely(green('Pocketed !'))
+    printNicely('')
+
+
 def retweet():
     """
     ReTweet
@@ -419,7 +548,9 @@ def quote():
         printNicely(red('Sorry I can\'t understand.'))
         return
     tid = c['tweet_dict'][id]
-    tweet = t.statuses.show(id=tid)
+    kwargs = {'id': tid}
+    kwargs = add_tweetmode_parameter(kwargs)
+    tweet = t.statuses.show(**kwargs)
     # Get formater
     formater = format_quote(tweet)
     if not formater:
@@ -453,7 +584,9 @@ def allretweet():
     except:
         num = c['RETWEETS_SHOW_NUM']
     # Get result and display
-    rt_ary = t.statuses.retweets(id=tid, count=num)
+    kwargs = {'id': tid, 'count': num}
+    kwargs = add_tweetmode_parameter(kwargs)
+    rt_ary = t.statuses.retweets(**kwargs)
     if not rt_ary:
         printNicely(magenta('This tweet has no retweet.'))
         return
@@ -473,14 +606,17 @@ def conversation():
         printNicely(red('Sorry I can\'t understand.'))
         return
     tid = c['tweet_dict'][id]
-    tweet = t.statuses.show(id=tid)
+    kwargs = {'id': tid}
+    kwargs = add_tweetmode_parameter(kwargs)
+    tweet = t.statuses.show(**kwargs)
     limit = c['CONVERSATION_MAX']
     thread_ref = []
     thread_ref.append(tweet)
     prev_tid = tweet['in_reply_to_status_id']
     while prev_tid and limit:
         limit -= 1
-        tweet = t.statuses.show(id=prev_tid)
+        kwargs['id'] = prev_tid
+        tweet = t.statuses.show(**kwargs)
         prev_tid = tweet['in_reply_to_status_id']
         thread_ref.append(tweet)
 
@@ -502,7 +638,12 @@ def reply():
     tid = c['tweet_dict'][id]
     user = t.statuses.show(id=tid)['user']['screen_name']
     status = ' '.join(g['stuff'].split()[1:])
-    status = '@' + user + ' ' + str2u(status)
+    # don't include own username for tweet chains
+    # for details see issue https://github.com/DTVD/rainbowstream/issues/163
+    if user == g['original_name']:
+        status = str2u(status)
+    else:
+        status = '@' + user + ' ' + str2u(status)
     t.statuses.update(status=status, in_reply_to_status_id=tid)
 
 
@@ -519,11 +660,13 @@ def reply_all():
     tid = c['tweet_dict'][id]
     original_tweet = t.statuses.show(id=tid)
     text = original_tweet['text']
-    owner = '@' + original_tweet['user']['screen_name']
-    nick_ary = ['@' + re.sub('[\W_]', '', w)
-                for w in text.split() if w.startswith('@')] + [owner]
+    nick_ary = [original_tweet['user']['screen_name']]
+    for user in list(original_tweet['entities']['user_mentions']):
+        if user['screen_name'] not in nick_ary \
+                and user['screen_name'] != g['original_name']:
+            nick_ary.append(user['screen_name'])
     status = ' '.join(g['stuff'].split()[1:])
-    status = ' '.join(nick_ary) + ' ' + str2u(status)
+    status = ' '.join(['@' + nick for nick in nick_ary]) + ' ' + str2u(status)
     t.statuses.update(status=status, in_reply_to_status_id=tid)
 
 
@@ -540,7 +683,9 @@ def favorite():
     tid = c['tweet_dict'][id]
     t.favorites.create(_id=tid, include_entities=False)
     printNicely(green('Favorited.'))
-    draw(t.statuses.show(id=tid))
+    kwargs = {'id': tid}
+    kwargs = add_tweetmode_parameter(kwargs)
+    draw(t.statuses.show(**kwargs))
     printNicely('')
 
 
@@ -557,7 +702,9 @@ def unfavorite():
     tid = c['tweet_dict'][id]
     t.favorites.destroy(_id=tid)
     printNicely(green('Okay it\'s unfavorited.'))
-    draw(t.statuses.show(id=tid))
+    kwargs = {'id': tid}
+    kwargs = add_tweetmode_parameter(kwargs)
+    draw(t.statuses.show(**kwargs))
     printNicely('')
 
 
@@ -572,7 +719,9 @@ def share():
     except:
         printNicely(red('Tweet id is not valid.'))
         return
-    tweet = t.statuses.show(id=tid)
+    kwargs = {'id': tid}
+    kwargs = add_tweetmode_parameter(kwargs)
+    tweet = t.statuses.show(**kwargs)
     url = 'https://twitter.com/' + \
         tweet['user']['screen_name'] + '/status/' + str(tid)
     import platform
@@ -630,14 +779,14 @@ def urlopen():
             return
         tid = c['tweet_dict'][int(g['stuff'])]
         tweet = t.statuses.show(id=tid)
-        link_prefix = ('http://', 'https://')
-        link_ary = [u for u in tweet['text'].split()
-                    if u.startswith(link_prefix)]
-        if not link_ary:
+        urls = tweet['entities']['urls']
+        if not urls:
             printNicely(light_magenta('No url here @.@!'))
             return
-        for link in link_ary:
-            webbrowser.open(link)
+        else:
+            for url in urls:
+                expanded_url = url['expanded_url']
+                webbrowser.open(expanded_url)
     except:
         debug_option()
         printNicely(red('Sorry I can\'t open url in this tweet.'))
@@ -780,28 +929,46 @@ def ls():
         target = g['stuff'].split()[0]
     except:
         printNicely(red('Omg some syntax is wrong.'))
+        return
     # Init cursor
     d = {'fl': 'followers', 'fr': 'friends'}
     next_cursor = -1
     rel = {}
+
+    printNicely('All ' + d[target] + ':')
+
     # Cursor loop
+    number_of_users = 0
     while next_cursor != 0:
+
         list = getattr(t, d[target]).list(
             screen_name=name,
             cursor=next_cursor,
             skip_status=True,
             include_entities=False,
         )
+
         for u in list['users']:
-            rel[u['name']] = '@' + u['screen_name']
+
+            number_of_users += 1
+
+            # Print out result
+            printNicely(   '  '                                               \
+                         + cycle_color( u['name'] )                           \
+                         + color_func(c['TWEET']['nick'])(    ' @'            \
+                                                           + u['screen_name'] \
+                                                           + ' ' ) )
+
         next_cursor = list['next_cursor']
-    # Print out result
-    printNicely('All: ' + str(len(rel)) + ' ' + d[target] + '.')
-    for name in rel:
-        user = '  ' + cycle_color(name)
-        user += color_func(c['TWEET']['nick'])(' ' + rel[name] + ' ')
-        printNicely(user)
 
+        # 300 users means 15 calls to the related API. The rate limit is 15
+        # calls per 15mn periods (see Twitter documentation).
+        if ( number_of_users % 300 == 0 ):
+            printNicely(light_yellow( 'We reached the limit of Twitter API.' ))
+            printNicely(light_yellow( 'You may need to wait about 15 minutes.' ))
+            break
+
+    printNicely('All: ' + str(number_of_users) + ' ' + d[target] + '.')
 
 def follow():
     """
@@ -846,7 +1013,7 @@ def mute():
             rel = t.mutes.users.create(screen_name=screen_name[1:])
             if isinstance(rel, dict):
                 printNicely(green(screen_name + ' is muted.'))
-                c['IGNORE_LIST'] += [unc(screen_name)]
+                c['IGNORE_LIST'] += [screen_name]
                 c['IGNORE_LIST'] = list(set(c['IGNORE_LIST']))
             else:
                 printNicely(red(rel))
@@ -1270,14 +1437,14 @@ def switch():
                 printNicely(light_magenta(guide))
                 only = raw_input('Only nicks [Ex: @xxx,@yy]: ')
                 ignore = raw_input('Ignore nicks [Ex: @xxx,@yy]: ')
-                args.filter = filter(None, only.split(','))
-                args.ignore = filter(None, ignore.split(','))
+                args.filter = list(filter(None, only.split(',')))
+                args.ignore = list(filter(None, ignore.split(',')))
         except:
             printNicely(red('Sorry, wrong format.'))
             return
         # Kill old thread
         g['stream_stop'] = True
-        try: 
+        try:
             stuff = g['stuff'].split()[1]
         except:
             stuff = None
@@ -1400,7 +1567,7 @@ def config():
             debug_option()
             printNicely(red('Just can not set the key.'))
     else:
-        printNicely(light_magenta('Sorry I can\'s understand.'))
+        printNicely(light_magenta('Sorry I can\'t understand.'))
 
 
 def help_discover():
@@ -1416,6 +1583,8 @@ def help_discover():
         light_green('trend JP Tokyo') + '.\n'
     usage += s * 2 + light_green('home') + ' will show your timeline. ' + \
         light_green('home 7') + ' will show 7 tweets.\n'
+    usage += s * 2 + light_green('me') + ' will show your latest tweets. ' + \
+        light_green('me 2') + ' will show your last 2 tweets.\n'
     usage += s * 2 + \
         light_green('notification') + ' will show your recent notification.\n'
     usage += s * 2 + light_green('mentions') + ' will show mentions timeline. ' + \
@@ -1474,6 +1643,8 @@ def help_tweets():
         light_yellow('[id=12]') + ' in your OS\'s image viewer.\n'
     usage += s * 2 + light_green('open 12') + ' will open url in tweet with ' + \
         light_yellow('[id=12]') + ' in your OS\'s default browser.\n'
+    usage += s * 2 + light_green('pt 12') + '  will add tweet with ' + \
+        light_yellow('[id=12]') + ' in your Pocket list.\n'
     printNicely(usage)
 
 
@@ -1740,6 +1911,7 @@ cmdset = [
     't',
     'rt',
     'quote',
+    'me',
     'allrt',
     'conversation',
     'fav',
@@ -1775,6 +1947,7 @@ cmdset = [
     'c',
     'v',
     'q',
+    'pt',
 ]
 
 # Handle function set
@@ -1788,6 +1961,7 @@ funcset = [
     tweet,
     retweet,
     quote,
+    view_my_tweets,
     allretweet,
     conversation,
     favorite,
@@ -1823,6 +1997,7 @@ funcset = [
     clear,
     upgrade_center,
     quit,
+    pocket,
 ]
 
 
@@ -1849,6 +2024,7 @@ def listen():
             [],  # tweet
             [],  # retweet
             [],  # quote
+            [],  # view_my_tweets
             [],  # allretweet
             [],  # conversation
             [],  # favorite
@@ -1903,6 +2079,7 @@ def listen():
             [],  # clear
             [],  # version
             [],  # quit
+            [],  # pocket
         ]
     ))
     init_interactive_shell(d)
@@ -1927,6 +2104,7 @@ def listen():
             c['lock'] = True
             # Save cmd to global variable and call process
             g['stuff'] = ' '.join(line.split()[1:])
+            # Check tweet length
             # Process the command
             process(cmd)()
             # Not re-display
@@ -1934,13 +2112,16 @@ def listen():
                 g['prefix'] = False
             else:
                 g['prefix'] = True
-            # Release the semaphore lock
-            c['lock'] = False
         except EOFError:
             printNicely('')
+        except TwitterHTTPError as e:
+            detail_twitter_error(e)
         except Exception:
             debug_option()
-            printNicely(red('OMG something is wrong with Twitter right now.'))
+            printNicely(red('OMG something is wrong with Twitter API right now.'))
+        finally:
+            # Release the semaphore lock
+            c['lock'] = False
 
 
 def reconn_notice():
@@ -1965,7 +2146,7 @@ def stream(domain, args, name='Rainbow Stream'):
     # The Logo
     art_dict = {
         c['USER_DOMAIN']: name,
-        c['PUBLIC_DOMAIN']: args.track_keywords,
+        c['PUBLIC_DOMAIN']: args.track_keywords or 'Global',
         c['SITE_DOMAIN']: name,
     }
     if c['ASCII_ART']:
@@ -2065,7 +2246,7 @@ def stream(domain, args, name='Rainbow Stream'):
         detail_twitter_error(e)
         sys.stdout.write(g['decorated_name'](g['PREFIX']))
         sys.stdout.flush()
-    except (URLError, ConnectionResetError):
+    except (URLError):
         printNicely(
             magenta('There seems to be a connection problem.'))
         save_history()
@@ -2081,11 +2262,11 @@ def spawn_public_stream(args, keyword=None):
         if keyword[0] == '#':
             keyword = keyword[1:]
         args.track_keywords = keyword
-    # Set the variable to tracked keyword
-    g['keyword'] = keyword
-    g['listname'] = ''
-    # Reset prefix
+        g['keyword'] = keyword
+    else:
+        g['keyword'] = 'Global'
     g['PREFIX'] = u2str(emojize(format_prefix(keyword=g['keyword'])))
+    g['listname'] = ''
     # Start new thread
     th = threading.Thread(
         target=stream,
@@ -2104,7 +2285,7 @@ def spawn_list_stream(args, stuff=None):
         owner, slug = check_slug(stuff)
     except:
         owner, slug = get_slug()
-    
+
     # Force python 2 not redraw readline buffer
     listname = '/'.join([owner, slug])
     # Set the listname variable
@@ -2195,20 +2376,19 @@ def fly():
 
     # Spawn stream thread
     target = args.stream.split()[0]
-    if target == 'mine' :
+    if target == 'mine':
         spawn_personal_stream(args)
-    else :
+    else:
         try:
             stuff = args.stream.split()[1]
-            spawn_dict = {
-                'public': spawn_public_stream,
-                'list': spawn_list_stream,
-            }
-            spawn_dict.get(target)(args, stuff)
         except:
-            printNicely(red('Wrong -s/--stream argument given. Loading your personal stream.'))
-            spawn_personal_stream(args)
-    
+            stuff = None
+        spawn_dict = {
+            'public': spawn_public_stream,
+            'list': spawn_list_stream,
+        }
+        spawn_dict.get(target)(args, stuff)
+
     # Start listen process
     time.sleep(0.5)
     g['reset'] = True