refactoring and add various comments
[rainbowstream.git] / rainbowstream / rainbow.py
index f543b35..55e062c 100644 (file)
@@ -11,7 +11,6 @@ import argparse
 import time
 import requests
 import webbrowser
-import json
 
 from twitter.stream import TwitterStream, Timeout, HeartbeatTimeout, Hangup
 from twitter.api import *
@@ -28,9 +27,13 @@ from .db import *
 from .c_image import *
 from .py3patch import *
 
-
+# Global values
 g = {}
+
+# Database
 db = RainbowDB()
+
+# Commands
 cmdset = [
     'switch',
     'trend',
@@ -64,6 +67,7 @@ cmdset = [
     'report',
     'list',
     'cal',
+    'config',
     'theme',
     'h',
     'c',
@@ -133,19 +137,22 @@ def authen():
         CONSUMER_SECRET)
 
 
-def get_decorated_name():
+def init():
     """
-    Beginning of every line
+    Init function
     """
+    # Get name
     t = Twitter(auth=authen())
     name = '@' + t.account.verify_credentials()['screen_name']
     g['original_name'] = name[1:]
     g['decorated_name'] = color_func(c['DECORATED_NAME'])('[' + name + ']: ')
-
+    # Theme init
     files = os.listdir(os.path.dirname(__file__) + '/colorset')
     themes = [f.split('.')[0] for f in files if f.split('.')[-1] == 'json']
     g['themes'] = themes
     db.theme_store(c['THEME'])
+    # Semaphore init
+    db.semaphore_store(False)
 
 
 def switch():
@@ -154,7 +161,6 @@ def switch():
     """
     try:
         target = g['stuff'].split()[0]
-
         # Filter and ignore
         args = parse_arguments()
         try:
@@ -169,7 +175,6 @@ def switch():
         except:
             printNicely(red('Sorry, wrong format.'))
             return
-
         # Public stream
         if target == 'public':
             keyword = g['stuff'].split()[1]
@@ -186,7 +191,6 @@ def switch():
                     args))
             p.start()
             g['stream_pid'] = p.pid
-
         # Personal stream
         elif target == 'mine':
             # Kill old process
@@ -224,7 +228,6 @@ def trend():
         town = g['stuff'].split()[1]
     except:
         town = ''
-
     avail = t.trends.available()
     # World wide
     if not country:
@@ -438,19 +441,17 @@ def search():
     Search
     """
     t = Twitter(auth=authen())
-    if g['stuff'].startswith('#'):
-        rel = t.search.tweets(q=g['stuff'])['statuses']
-        if rel:
-            printNicely('Newest tweets:')
-            for i in reversed(xrange(c['SEARCH_MAX_RECORD'])):
-                draw(t=rel[i],
-                     iot=g['iot'],
-                     keyword=g['stuff'].strip()[1:])
-            printNicely('')
-        else:
-            printNicely(magenta('I\'m afraid there is no result'))
+    g['stuff'] = g['stuff'].strip()
+    rel = t.search.tweets(q=g['stuff'])['statuses']
+    if rel:
+        printNicely('Newest tweets:')
+        for i in reversed(xrange(c['SEARCH_MAX_RECORD'])):
+            draw(t=rel[i],
+                 iot=g['iot'],
+                 keyword=g['stuff'])
+        printNicely('')
     else:
-        printNicely(red('A keyword should be a hashtag (like \'#AKB48\')'))
+        printNicely(magenta('I\'m afraid there is no result'))
 
 
 def message():
@@ -797,6 +798,24 @@ def report():
         printNicely(red('Sorry I can\'t understand.'))
 
 
+def get_slug():
+    """
+    Get Slug Decorator
+    """
+    # Get list name
+    list_name = raw_input(light_magenta('Give me the list\'s name: '))
+    # Get list name and owner
+    try:
+        owner, slug = list_name.split('/')
+        if slug.startswith('@'):
+            slug = slug[1:]
+        return owner, slug
+    except:
+        printNicely(
+            light_magenta('List name should follow "@owner/list_name" format.'))
+        raise Exception('Wrong list name')
+
+
 def show_lists(t):
     """
     List list
@@ -812,16 +831,7 @@ def list_home(t):
     """
     List home
     """
-    # Get list name
-    list_name = raw_input(light_magenta('Give me the list\'s name: '))
-    # Get list name and owner
-    try:
-        owner, slug = list_name.split('/')
-        if slug.startswith('@'):
-            slug = slug[1:]
-    except:
-        printNicely(light_magenta('Please follow "@owner/list_name" format.'))
-        return
+    owner, slug = get_slug()
     res = t.lists.statuses(
         slug=slug,
         owner_screen_name=owner,
@@ -836,16 +846,7 @@ def list_members(t):
     """
     List members
     """
-    # Get list name
-    list_name = raw_input(light_magenta('Give me the list\'s name: '))
-    # Get list name and owner
-    try:
-        owner, slug = list_name.split('/')
-        if slug.startswith('@'):
-            slug = slug[1:]
-    except:
-        printNicely(light_magenta('Please follow "@owner/list_name" format.'))
-        return
+    owner, slug = get_slug()
     # Get members
     rel = {}
     next_cursor = -1
@@ -869,16 +870,7 @@ def list_subscribers(t):
     """
     List subscribers
     """
-    # Get list name
-    list_name = raw_input(light_magenta('Give me the list\'s name: '))
-    # Get list name and owner
-    try:
-        owner, slug = list_name.split('/')
-        if slug.startswith('@'):
-            slug = slug[1:]
-    except:
-        printNicely(light_magenta('Please follow "@owner/list_name" format.'))
-        return
+    owner, slug = get_slug()
     # Get subscribers
     rel = {}
     next_cursor = -1
@@ -902,16 +894,7 @@ def list_add(t):
     """
     Add specific user to a list
     """
-    # Get list name
-    list_name = raw_input(light_magenta('Give me the list\'s name: '))
-    # Get list name and owner
-    try:
-        owner, slug = list_name.split('/')
-        if slug.startswith('@'):
-            slug = slug[1:]
-    except:
-        printNicely(light_magenta('Please follow "@owner/list_name" format.'))
-        return
+    owner, slug = get_slug()
     # Add
     user_name = raw_input(light_magenta('Give me name of the newbie: '))
     if user_name.startswith('@'):
@@ -930,16 +913,7 @@ def list_remove(t):
     """
     Remove specific user from a list
     """
-    # Get list name
-    list_name = raw_input(light_magenta('Give me the list\'s name: '))
-    # Get list name and owner
-    try:
-        owner, slug = list_name.split('/')
-        if slug.startswith('@'):
-            slug = slug[1:]
-    except:
-        printNicely(light_magenta('Please follow "@owner/list_name" format.'))
-        return
+    owner, slug = get_slug()
     # Remove
     user_name = raw_input(light_magenta('Give me name of the unlucky one: '))
     if user_name.startswith('@'):
@@ -958,16 +932,7 @@ def list_subscribe(t):
     """
     Subscribe to a list
     """
-    # Get list name
-    list_name = raw_input(light_magenta('Give me the list\'s name: '))
-    # Get list name and owner
-    try:
-        owner, slug = list_name.split('/')
-        if slug.startswith('@'):
-            slug = slug[1:]
-    except:
-        printNicely(light_magenta('Please follow "@owner/list_name" format.'))
-        return
+    owner, slug = get_slug()
     # Subscribe
     try:
         t.lists.subscribers.create(
@@ -983,16 +948,7 @@ def list_unsubscribe(t):
     """
     Unsubscribe a list
     """
-    # Get list name
-    list_name = raw_input(light_magenta('Give me the list\'s name: '))
-    # Get list name and owner
-    try:
-        owner, slug = list_name.split('/')
-        if slug.startswith('@'):
-            slug = slug[1:]
-    except:
-        printNicely(light_magenta('Please follow "@owner/list_name" format.'))
-        return
+    owner, slug = get_slug()
     # Subscribe
     try:
         t.lists.subscribers.destroy(
@@ -1108,7 +1064,7 @@ def list():
     try:
         return action_ary[g['list_action']](t)
     except:
-        printNicely(red('Sorry I can\'t understand.'))
+        printNicely(red('Please try again.'))
 
 
 def cal():
@@ -1122,6 +1078,52 @@ def cal():
     show_calendar(month, date, rel)
 
 
+def config():
+    """
+    Browse and change config
+    """
+    all_config = get_all_config()
+    g['stuff'] = g['stuff'].strip()
+    # List all config
+    if not g['stuff']:
+        for k in all_config:
+            line = ' ' * 2 + \
+                light_green(k) + ': ' + light_yellow(str(all_config[k]))
+            printNicely(line)
+        guide = 'Detailed explanation can be found at ' + \
+            color_func(c['TWEET']['link'])(
+                'http://rainbowstream.readthedocs.org/en/latest/#config-explanation')
+        printNicely(guide)
+    # Print specific config
+    elif len(g['stuff'].split()) == 1:
+        if g['stuff'] in all_config:
+            k = g['stuff']
+            line = ' ' * 2 + \
+                light_green(k) + ': ' + light_yellow(str(all_config[k]))
+            printNicely(line)
+        else:
+            printNicely(red('No config key like this.'))
+    # Print specific config's default value
+    elif len(g['stuff'].split()) == 2 and g['stuff'].split()[-1] == 'default':
+        key = g['stuff'].split()[0]
+        value = get_default_config(key)
+        line = ' ' * 2 + light_green(key) + ': ' + light_magenta(value)
+        printNicely(line)
+    # Set specific config
+    elif len(g['stuff'].split()) == 3 and g['stuff'].split()[1] == '=':
+        key = g['stuff'].split()[0]
+        value = g['stuff'].split()[-1]
+        try:
+            set_config(key, value)
+            printNicely(light_green('Updated successfully.'))
+        except:
+            printNicely(light_magenta('Not valid value.'))
+            return
+        reload_config()
+    else:
+        printNicely(light_magenta('Sorry I can\'s understand.'))
+
+
 def theme():
     """
     List and change theme
@@ -1137,24 +1139,7 @@ def theme():
             printNicely(line)
     elif g['stuff'] == 'current_as_default':
         # Set as default
-        def fixup(adict, k, v):
-            for key in adict.keys():
-                if key == k:
-                    adict[key] = v
-                elif type(adict[key]) is dict:
-                    fixup(adict[key], k, v)
-        # Modify
-        path = os.environ.get(
-            'HOME',
-            os.environ.get(
-                'USERPROFILE',
-                '')) + os.sep + '.rainbow_config.json'
-        data = load_config(rainbow_config)
-        fixup(data, 'THEME', c['THEME'])
-        # Save
-        with open(path, 'w') as out:
-            json.dump(data, out, indent = 4)
-        os.system('chmod 777 ' + path)
+        set_config('THEME', c['THEME'])
         printNicely(light_green('Okay it will be applied from next time :)'))
     else:
         # Change theme
@@ -1175,7 +1160,7 @@ def theme():
             # Update db and reset colors
             db.theme_update(g['stuff'])
             c['THEME'] = g['stuff']
-            reset_cycle()
+            start_cycle()
             g['decorated_name'] = color_func(
                 c['DECORATED_NAME'])(
                 '[@' + g['original_name'] + ']: ')
@@ -1203,8 +1188,9 @@ def help_discover():
         magenta('@mdo') + '.\n'
     usage += s * 2 + light_green('view @mdo') + \
         ' will show ' + magenta('@mdo') + '\'s home.\n'
-    usage += s * 2 + light_green('s #AKB48') + ' will search for "' + \
-        light_yellow('AKB48') + '" and return 5 newest tweet.\n'
+    usage += s * 2 + light_green('s AKB48') + ' will search for "' + \
+        light_yellow('AKB48') + '" and return 5 newest tweet. ' + \
+        'Search can be performed with or without hashtag.\n'
     printNicely(usage)
 
 
@@ -1365,7 +1351,6 @@ def help():
     """
     s = ' ' * 2
     h, w = os.popen('stty size', 'r').read().split()
-
     # Start
     usage = '\n'
     usage += s + 'Hi boss! I\'m ready to serve you right now!\n'
@@ -1375,7 +1360,6 @@ def help():
     usage += s + 'Any update from Twitter will show up ' + \
         light_yellow('immediately') + '.\n'
     usage += s + 'In addtion, following commands are available right now:\n'
-
     # Twitter help section
     usage += '\n'
     usage += s + grey(u'\u266A' + ' Twitter help\n')
@@ -1391,7 +1375,6 @@ def help():
         ' will show help for list commands.\n'
     usage += s * 2 + light_green('h stream') + \
         ' will show help for stream commands.\n'
-
     # Smart shell
     usage += '\n'
     usage += s + grey(u'\u266A' + ' Smart shell\n')
@@ -1399,22 +1382,33 @@ def help():
         'will be evaluate by Python interpreter.\n'
     usage += s * 2 + 'Even ' + light_green('cal') + ' will show the calendar' + \
         ' for current month.\n'
-
-    # Screening
+    # Config
     usage += '\n'
-    usage += s + grey(u'\u266A' + ' Screening \n')
-    usage += s * 2 + light_green('theme') + ' will list available theme.' + \
+    usage += s + grey(u'\u266A' + ' Config \n')
+    usage += s * 2 + light_green('theme') + ' will list available theme. ' + \
         light_green('theme monokai') + ' will apply ' + light_yellow('monokai') + \
         ' theme immediately.\n'
+    usage += s * 2 + light_green('config') + ' will list all config.\n'
+    usage += s * 3 + \
+        light_green('config ASCII_ART') + ' will output current value of ' +\
+        light_yellow('ASCII_ART') + ' config key.\n'
+    usage += s * 3 + \
+        light_green('config ASCII_ART default') + ' will output default value of ' + \
+        light_yellow('ASCII_ART') + ' config key.\n'
+    usage += s * 3 + \
+        light_green('config ASCII_ART = False') + ' will set value of ' + \
+        light_yellow('ASCII_ART') + ' config key to ' + \
+        light_yellow('False') + '.\n'
+    # Screening
+    usage += '\n'
+    usage += s + grey(u'\u266A' + ' Screening \n')
     usage += s * 2 + light_green('h') + ' will show this help again.\n'
     usage += s * 2 + light_green('c') + ' will clear the screen.\n'
     usage += s * 2 + light_green('q') + ' will quit.\n'
-
     # End
     usage += '\n'
     usage += s + '-' * (int(w) - 4) + '\n'
     usage += s + 'Have fun and hang tight! \n'
-
     # Show help
     d = {
         'discover': help_discover,
@@ -1499,6 +1493,7 @@ def process(cmd):
             report,
             list,
             cal,
+            config,
             theme,
             help,
             clear,
@@ -1558,6 +1553,7 @@ def listen():
                 'del'
             ],  # list
             [],  # cal
+            [key for key in dict(get_all_config())],  # config
             g['themes'] + ['current_as_default'],  # theme
             [
                 'discover',
@@ -1584,24 +1580,28 @@ def listen():
         except:
             cmd = ''
         g['cmd'] = cmd
-        # Save cmd to global variable and call process
         try:
+            # Lock the semaphore
+            db.semaphore_update(True)
+            # Save cmd to global variable and call process
             g['stuff'] = ' '.join(line.split()[1:])
+            # Process the command
             process(cmd)()
+            # Not re-display
+            if cmd in ['switch', 't', 'rt', 'rep']:
+                g['prefix'] = False
+            else:
+                g['prefix'] = True
+            # Release the semaphore lock
+            db.semaphore_update(False)
         except Exception:
             printNicely(red('OMG something is wrong with Twitter right now.'))
-        # Not redisplay prefix
-        if cmd in ['switch', 't', 'rt', 'rep']:
-            g['prefix'] = False
-        else:
-            g['prefix'] = True
 
 
 def stream(domain, args, name='Rainbow Stream'):
     """
     Track the stream
     """
-
     # The Logo
     art_dict = {
         c['USER_DOMAIN']: name,
@@ -1610,24 +1610,20 @@ def stream(domain, args, name='Rainbow Stream'):
     }
     if c['ASCII_ART']:
         ascii_art(art_dict[domain])
-
     # These arguments are optional:
     stream_args = dict(
         timeout=args.timeout,
         block=not args.no_block,
         heartbeat_timeout=args.heartbeat_timeout)
-
     # Track keyword
     query_args = dict()
     if args.track_keywords:
         query_args['track'] = args.track_keywords
-
     # Get stream
     stream = TwitterStream(
         auth=authen(),
         domain=domain,
         **stream_args)
-
     try:
         if domain == c['USER_DOMAIN']:
             tweet_iter = stream.user(**query_args)
@@ -1638,8 +1634,6 @@ def stream(domain, args, name='Rainbow Stream'):
                 tweet_iter = stream.statuses.filter(**query_args)
             else:
                 tweet_iter = stream.statuses.sample()
-
-        # Iterate over the stream.
         for tweet in tweet_iter:
             if tweet is None:
                 printNicely("-- None --")
@@ -1654,6 +1648,7 @@ def stream(domain, args, name='Rainbow Stream'):
                     t=tweet,
                     iot=args.image_on_term,
                     keyword=args.track_keywords,
+                    check_semaphore=True,
                     fil=args.filter,
                     ig=args.ignore,
                 )
@@ -1667,11 +1662,10 @@ def fly():
     """
     Main function
     """
-    # Spawn stream process
+    # Initial
     args = parse_arguments()
     try:
-        get_decorated_name()
-
+        init()
     except TwitterHTTPError:
         printNicely('')
         printNicely(
@@ -1681,7 +1675,7 @@ def fly():
         save_history()
         os.system('rm -rf rainbow.db')
         sys.exit()
-
+    # Spawn stream process
     p = Process(
         target=stream,
         args=(
@@ -1689,7 +1683,6 @@ def fly():
             args,
             g['original_name']))
     p.start()
-
     # Start listen process
     time.sleep(0.5)
     g['reset'] = True