Merge Branch master => stable

Author: harshadyeola

CHANGELOG.txt

@@ -1,3 +1,9 @@
+v 3.0.7 - April 9,2015
+- Fixed #445
+- Fixed #413
+- Small bug fixes.
+- Improvements in core functionality.
+
 v 3.0.6 - April 2,2015
 - Added `update` command to update EasyEngine.
 

README.md

@@ -21,10 +21,16 @@ sudo ee site create example.com --wp        # Install required packages & setup
 ## Update EasyEngine
 
 
-Update Procedure For EasyEngine to version 3.0.5
+Update procedure for EasyEngine to latest version
 
+#### For current installed version prior to 3.0.6
 ```bash
 wget -qO ee rt.cx/ee && sudo bash ee
+
+```
+#### Current version is 3.0.6
+```
+ee update
 ```
 
 ## More Site Creation Commands
@@ -85,7 +91,7 @@ ee site create example.com --mysql    # create example.com with php & mysql supp
 
 ## Careers
 
-We are looking for [Python Developers] (https://rtcamp.com/careers/python-developer/) to join our team. 
+We are looking for [Python Developers] (https://rtcamp.com/careers/python-developer/) to join our team.
 
 We offer work from home, so you can join EasyEngine team anywhere! _[Why Python?] (https://rtcamp.com/blog/easyengine-3-roadmap/#whypython)_
 

config/bash_completion.d/ee_auto.rc

@@ -11,7 +11,7 @@ _ee_complete()
     # SETUP THE BASE LEVEL (everything after "ee")
     if [ $COMP_CWORD -eq 1 ]; then
         COMPREPLY=( $(compgen \
-                      -W "stack site debug clean secure import-slow-log log" \
+                      -W "stack site debug clean secure import-slow-log log update" \
                       -- $cur) )
 
 
@@ -74,7 +74,7 @@ _ee_complete()
             # HANDLE EVERYTHING AFTER THE THIRD LEVEL NAMESPACE
             "install" | "purge" | "remove" )
                 COMPREPLY=( $(compgen \
-                              -W "--web --admin --mail --nginx --php --mysql --postfix --wpcli --phpmyadmin --adminer --utils --memcache --dovecot --all" \
+                              -W "--web --admin --mail --nginx --php --mysql --postfix --wpcli --phpmyadmin --adminer --utils --memcache --dovecot --all --mailscanner" \
                               -- $cur) )
                 ;;
             "start" | "stop" | "reload" | "restart" | "status")

config/plugins.d/update.conf

@@ -0,0 +1,8 @@
+### Example Plugin Configuration for EasyEngine
+
+[update]
+
+### If enabled, load a plugin named `example` either from the Python module
+### `ee.cli.plugins.example` or from the file path
+### `/var/lib/ee/plugins/example.py`
+enable_plugin = true

docs/ee.8

@@ -17,15 +17,15 @@ ee site update example.com [ --php | --mysql] [[--wp | --wpsubdir | --wpsubdomai
 .TP
 ee site delete example.com [--db | --files | --all | --no-prompt ]
 .TP
-ee debug [ -i | --nginx | --rewrite | --php | --fpm | --mysql ] [--stop ]
+ee debug [ -i | --all=on/off |--nginx=on/off | --rewrite=on/off | --php=on/off | --fpm=on/off | --mysql=on/off ]
 .TP
-ee debug example.com [ -i | --nginx | --rewrite | --wp ] [--stop ]
+ee debug example.com [ -i | --all=on/off | --nginx=on/off | --rewrite=on/off | --wp=on/off ]
 .TP
 ee secure [ --auth | --port | --ip ]
 .SH DESCRIPTION
 EasyEngine aka ee is the opensource project developed with the purpose to automate web-server configuration.
 .br
-EasyEngine is the collection of shell scripts that provides automation for the web-server
+EasyEngine is the collection of python script that provides automation for the web-server
 .br
 installation, site creation, services debugging & monitoring.
 .SH OPTIONS
@@ -95,7 +95,7 @@ Change directory to webroot of specified site in subshell.
 .br
 monitor access and error logs for site specified.
 .TP
-.B list [ enable | available ]
+.B list [ --enabled | --disabled ]
 .br
 Lists all available sites from /etc/nginx/sites-enabled/
 .br
@@ -143,21 +143,21 @@ Update site configuration according to specified options.
 .br
 Delete site i.e webroot, database, ad configuration permenantly.
 .TP
-.B debug [ -i | --nginx | --php | --mysql | --rewrite | --fpm ] [ --start | --stop ]
+.B debug [ -i | --nginx=on/off | --php=on/off | --mysql=on/off | --rewrite=on/off | --fpm=on/off ]
 .br
-Starts server level debugging. If used without arguments starts debugging
+Starts server level debugging. If this is used without arguments it will start debugging
 .br
-all services, else debug only service provided with argument. Stop
+all services.Else it will debug only service provided with argument.This will Stop
 .br
-Debugging if used with --stop argument.
+Debugging if used with --all=off argument.
 .TP
-.B debug example.com [ -i | --nginx | --rewrite | --wp ] [ --start | --stop ]
+.B debug example.com [ -i | --nginx=on/off | --rewrite=on/off | --wp=on/off | --all=on/off ]
 .br
-Starts site level debugging. If used without arguments starts debugging all
+Starts site level debugging. If this is used without arguments it will start debugging all
 .br
-services, else debug only service provided with argument. Stop Debugging
+services.Else it will debug only service provided with argument.This will Stop Debugging
 .br
-if used with --stop argument.
+if used with --all=off argument.
 .TP
 .B secure [ --auth | --port ]
 .br
@@ -174,35 +174,35 @@ Clean NGINX fastCGI cache if no option specified.
 .br
 setup intractive mode while used with debug.
 .TP
-.B --nginx
+.B --nginx=on/off
 .br
 used with ee debug command. used to start or stop nginx debugging.
 .TP
-.B --php
+.B --php=on/off
 .br
 used with ee debug command. used to start or stop php debugging.
 .TP
-.B --mysql
+.B --mysql=on/off
 .br
 used with ee debug command. used to start or stop mysql debugging.
 .TP
-.B --rewrite
+.B --rewrite=on/off
 .br
 used with ee debug command. used to start or stop nginx rewrite rules debugging.
 .TP
-.B --fpm
+.B --fpm=on/off
 .br
 used with ee debug command. used to start or stop fpm debugging.
 .TP
-.B --wp
+.B --wp=on/off
 .br
-used with ee debug command. used to start or stop wordpress site debugging.
+used with ee debug command. used to start or stop  wordpress site debugging.
 .TP
-.B --start
+.B --all=on/off
 .br
 used with ee debug command. used to stop debugging.
 .TP
-.B --stop
+.B --all=off
 .br
 used with ee debug command. used to stop debugging.
 .TP

ee/cli/plugins/clean.py

@@ -10,7 +10,7 @@
 import urllib.request
 
 
-def clean_plugin_hook(app):
+def ee_clean_hook(app):
     # do something with the ``app`` object here.
     pass
 
@@ -31,6 +31,7 @@ class Meta:
             (['--opcache'],
                 dict(help='Clean OpCache', action='store_true'))
             ]
+        usage = "ee clean [options]"
 
     @expose(hide=True)
     def default(self):
@@ -86,4 +87,4 @@ def load(app):
     # register the plugin class.. this only happens if the plugin is enabled
     handler.register(EECleanController)
     # register a hook (function) to run after arguments are parsed.
-    hook.register('post_argument_parsing', clean_plugin_hook)
+    hook.register('post_argument_parsing', ee_clean_hook)

ee/cli/plugins/debug.py

@@ -14,29 +14,8 @@
 import signal
 import subprocess
 
-usage = """
-Usage: ee debug {<sitename>} {arguments}
-
-arguments usage:
---all --all=on          start debugging all server parameters.
---all=off               stop debugging all server parameters
---nginx --nginx=on      start debugging nginx server configuration for site
---nginx=off             stop debugging nginx server configuration for site
---rewrite --rewrite=on  start debugging nginx rewrite rules for site
---rewrite=off           stop debugging nginx rewrite rules for site
---php --php=on          start debugging server php configuration
---php=off               stop debugging server php configuration
---fpm --fpm=on          start debugging fastcgi configuration
---fpm=off               stop debugging fastcgi configuration
---mysql --mysql=on      start debugging mysql server
---mysql=off             stop debugging mysql server
---wp --wp=on            start wordpress debugging
---wp=off                stop wordpress debugging
-
-"""
-
-
-def debug_plugin_hook(app):
+
+def ee_debug_hook(app):
     # do something with the ``app`` object here.
     pass
 
@@ -89,6 +68,7 @@ class Meta:
             (['site_name'],
                 dict(help='Website Name', nargs='?', default=None))
             ]
+        usage = "ee debug [<site_name>] [options] "
 
     @expose(hide=True)
     def debug_nginx(self):
@@ -493,9 +473,10 @@ def default(self):
            and (not self.app.pargs.all)
            and (not self.app.pargs.site_name)):
             if self.app.pargs.stop or self.app.pargs.start:
-                print("--start/stop option is deprecated in ee3.0.5", usage)
+                print("--start/stop option is deprecated since ee3.0.5")
+                self.app.args.print_help()
             else:
-                print(usage)
+                self.app.args.print_help()
 
         if self.app.pargs.all == 'on':
             if self.app.pargs.site_name:
@@ -519,7 +500,7 @@ def default(self):
            and (not self.app.pargs.fpm) and (not self.app.pargs.mysql)
            and (not self.app.pargs.wp) and (not self.app.pargs.rewrite)
            and self.app.pargs.site_name):
-            print(usage)
+            self.app.args.print_help()
             # self.app.pargs.nginx = 'on'
             # self.app.pargs.wp = 'on'
             # self.app.pargs.rewrite = 'on'
@@ -570,4 +551,4 @@ def load(app):
     # register the plugin class.. this only happens if the plugin is enabled
     handler.register(EEDebugController)
     # register a hook (function) to run after arguments are parsed.
-    hook.register('post_argument_parsing', debug_plugin_hook)
+    hook.register('post_argument_parsing', ee_debug_hook)

ee/cli/plugins/import_slow_log.py

@@ -6,7 +6,7 @@
 import os
 
 
-def import_slow_log_plugin_hook(app):
+def ee_import_slow_log_hook(app):
     pass
 
 
@@ -16,6 +16,7 @@ class Meta:
         stacked_on = 'base'
         stacked_type = 'nested'
         description = 'Import MySQL slow log to Anemometer database'
+        usage = "ee import-slow-log"
 
     @expose(hide=True)
     def default(self):
@@ -67,4 +68,4 @@ def load(app):
     handler.register(EEImportslowlogController)
 
     # register a hook (function) to run after arguments are parsed.
-    hook.register('post_argument_parsing', import_slow_log_plugin_hook)
+    hook.register('post_argument_parsing', ee_import_slow_log_hook)

ee/cli/plugins/info.py

@@ -10,7 +10,7 @@
 import configparser
 
 
-def info_plugin_hook(app):
+def ee_info_hook(app):
     # do something with the ``app`` object here.
     pass
 
@@ -33,6 +33,7 @@ class Meta:
                 dict(help='Get Nginx configuration information',
                      action='store_true')),
             ]
+        usage = "ee info [options]"
 
     @expose(hide=True)
     def info_nginx(self):
@@ -199,4 +200,4 @@ def load(app):
     handler.register(EEInfoController)
 
     # register a hook (function) to run after arguments are parsed.
-    hook.register('post_argument_parsing', info_plugin_hook)
+    hook.register('post_argument_parsing', ee_info_hook)

ee/cli/plugins/log.py

@@ -11,7 +11,7 @@
 import glob
 
 
-def log_plugin_hook(app):
+def ee_log_hook(app):
     # do something with the ``app`` object here.
     pass
 
@@ -43,6 +43,7 @@ class Meta:
             (['site_name'],
                 dict(help='Website Name', nargs='?', default=None))
             ]
+        usage = "ee log [<site_name>] [options]"
 
     @expose(hide=True)
     def default(self):
@@ -137,4 +138,4 @@ def load(app):
     # register the plugin class.. this only happens if the plugin is enabled
     handler.register(EELogController)
     # register a hook (function) to run after arguments are parsed.
-    hook.register('post_argument_parsing', log_plugin_hook)
+    hook.register('post_argument_parsing', ee_log_hook)