shadowsocks-manager 0.1.2__py2.py3-none-any.whl

bin/ssm-dev-start

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+#? Description:
+#?   Start the Django server, and the Celery beat and worker.
+#?   If you need to run the server under a specific Python environment, make
+#?   sure to activate it before to run the server.
+#?
+#? Usage:
+#?   ssm-dev-start.sh [[IP:]PORT]
+#?
+#? Options:
+#?   [[IP:]PORT]
+#?
+#?   The IP address and the port that the Django server is listening on.
+#?   The default IP address is `127.0.0.1`.
+#?   The default PORT is `8000`.
+#?
+
+# exit on any error
+set -e -o pipefail
+
+function main () {
+    declare listen=$1
+
+    # don't quote the variable $listen, leave it this way on purpose
+    # shellcheck disable=SC2086
+    ssm-manage runserver $listen --insecure &
+    sleep 1
+    ssm-celery -A shadowsocks_manager worker -l info -B &
+}
+
+main "$@"
+
+exit

bin/ssm-dev-stop

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+#? Description:
+#?   Stop the Django server, and the Celery beat and worker.
+#?
+#? Usage:
+#?   ssm-dev-stop.sh
+#?
+
+function main () {
+    # Kill the Celery processes
+    pkill -f "celery -A shadowsocks_manager"
+
+    # Kill the Django runserver process
+    pkill -f "python manage.py runserver"
+}
+
+main "$@"
+
+exit

bin/ssm-setup

@@ -0,0 +1,221 @@
+#!/usr/bin/env bash
+
+#? Description:
+#?   Setup shadowsocks-manager in your Python environment.
+#?   If you need to run the setup under a specific Python environment, make
+#?   sure to activate it before to run the setup.
+#?
+#? Usage:
+#?   ssm-setup.sh [-e ENV ...]
+#?                [-c] [-m] [-l] [-u USERNAME -p PASSWORD [-M EMAIL]] [-r PORT_BEGIN] [-R PORT_END] [-h]
+#?
+#? Options:
+#?   [-e ENV ...]
+#?
+#?   Set the environment variables in KEY=VALUE format for .env file.
+#?   The .env file is used by Django settings.
+#?   This option can be used multiple times.
+#?
+#?   The valid KEYs are:
+#?
+#?   - SSM_SECRET_KEY
+#?
+#?     Set Django's SECRET_KEY.
+#?     The default value is hardcoded in the .env file and Django's settings.
+#?     Do not use the default value in production environment.
+#?     Below command will generate a random SECRET_KEY:
+#?     ```sh
+#?     $ od -vN 25 -An -tx1 /dev/urandom | tr -d ' \n'
+#?     ```
+#?
+#?   - SSM_DEBUG
+#?
+#?     Set Django's DEBUG.
+#?     The value can be 'True' or 'False'.
+#?     The default value depends on the .env file and Django's settings.
+#?     Do not use value SSM_DEBUG=True in production environment.
+#?
+#?   - SSM_TIME_ZONE
+#?
+#?     Set Django's TIME_ZONE.
+#?     The value can be any valid timezone name.
+#?     The default value depends on the .env file and Django's settings.
+#?
+#?   - SSM_DATA_HOME
+#?
+#?     Set the base directory for the Django database and static files.
+#?     The default value depends on the .env file and Django's settings.
+#?
+#?   - SSM_MEMCACHED_HOST, SSM_MEMCACHED_PORT
+#?
+#?     Set the Memcached server's host and port which are used by Django cache.
+#?     The default value depends on the .env file and Django's settings.
+#? 
+#?   - SSM_RABBITMQ_HOST, SSM_RABBITMQ_PORT
+#?
+#?     Set the RabbitMQ server's host and port which are used by Celery.
+#?     The default value depends on the .env file and Django's settings.
+#?
+#?   However, this script will not check the validity of the KEYs and VALUEs.
+#?
+#?   [-c]
+#?
+#?   Collect Django static files.
+#?   This is necessary for the first time setup.
+#?
+#?   [-m]
+#?
+#?   Migrate Django database.
+#?   This is necessary for the first time setup.
+#?
+#?   [-l]
+#?
+#?   Load Django fixtures.
+#?   This is necessary for the first time setup.
+#?
+#?   [-u USERNAME]
+#?
+#?   Username for shadowsocks-manager administrator.
+#?   No default value.
+#?   This is necessary for the first time setup.
+#?
+#?   [-p PASSWORD]
+#?
+#?   Password for shadowsocks-manager administrator'.
+#?   No default value.
+#?   This is necessary for the first time setup.
+#?
+#?   [-M EMAIL]
+#?
+#?   Email for the shadowsocks-manager administrator.
+#?   Also, be used as the sender of the account notification Email.
+#?   No default value.
+#?
+#?   [-r PORT_BEGIN]
+#?
+#?   The beginning port number for Shadowsocks nodes.
+#?   The default value depends on the Django fixture data.
+#?
+#?   [-R PORT_END]
+#?
+#?   The ending port number for Shadowsocks nodes.
+#?   The default value depends on the Django fixture data.
+#?
+#?   [-h]
+#?
+#?   This help.
+#?
+#? Example:
+#?   # First time setup in development environment:
+#?   $ ssm-setup -c -m -l -u admin -p yourpassword
+#?
+#?   # Update a development environment to be production ready:
+#?   $ ssm-setup -e SSM_SECRET_KEY=yourkey -e SSM_DEBUG=False
+#?
+#?   # First time setup in production environment:
+#?   $ ssm-setup -e SSM_SECRET_KEY=yourkey -e SSM_DEBUG=False -c -m -l -u admin -p yourpassword -M admin@yourdomain.com
+#?
+
+# exit on any error
+set -e -o pipefail
+
+function usage () {
+    awk '/^#\?/ {sub("^[ ]*#\\?[ ]?", ""); print}' "$0" \
+        | awk '{gsub(/^[^ ]+.*/, "\033[1m&\033[0m"); print}'
+}
+
+function check-os () {
+    if [[ $(uname) != 'Linux' && $(uname) != 'Darwin' ]]; then
+        printf "fatal: this script support Linux and MacOS only.\n" >&2
+        return 255
+    fi
+}
+
+function main () {
+    declare -a envs
+    declare collect_flag migrate_flag loaddata_flag username password email port_begin port_end \
+            OPTIND OPTARG opt
+
+    while getopts e:cmlu:p:M:r:R:h opt; do
+        case $opt in
+            e)
+                envs+=("$OPTARG")
+                ;;
+            c)
+                collect_flag=1
+                ;;
+            m)
+                migrate_flag=1
+                ;;
+            l)
+                loaddata_flag=1
+                ;;
+            u)
+                username=$OPTARG
+                ;;
+            p)
+                password=$OPTARG
+                ;;
+            M)
+                email=$OPTARG
+                ;;
+            r)
+                port_begin=$OPTARG
+                ;;
+            R)
+                port_end=$OPTARG
+                ;;
+            *)
+                usage
+                exit 255
+                ;;
+        esac
+    done
+
+    check-os
+
+    if [[ $# -eq 0 ]]; then
+        usage
+        exit 255
+    fi
+
+    if [[ -n ${envs[*]} ]]; then
+        ssm-dotenv -w "${envs[@]}"
+    fi
+
+    if [[ -n $collect_flag ]]; then
+        ssm-manage collectstatic --no-input -c
+    fi
+
+    if [[ -n $migrate_flag ]]; then
+        ssm-manage makemigrations
+        ssm-manage migrate
+    fi
+
+    if [[ -n $loaddata_flag ]]; then
+        ssm-manage loaddata fixtures/auth.group.json \
+               fixtures/sites.site.json \
+               fixtures/django_celery_beat.crontabschedule.json \
+               fixtures/django_celery_beat.intervalschedule.json \
+               fixtures/django_celery_beat.periodictask.json \
+               config.json \
+               template.json \
+               nameserver.json
+    fi
+
+    if [[ -n $username && -n $password ]]; then
+        ssm-createsuperuser --username "$username" --password "$password" --email "$email"
+    fi
+
+    if [[ -n $port_begin ]]; then
+        ssm-manage shadowsocks_config --port-begin "$port_begin"
+    fi
+
+    if [[ -n $port_end ]]; then
+        ssm-manage shadowsocks_config --port-end "$port_end"
+    fi
+}
+
+main "$@"
+
+exit

bin/ssm-test

@@ -0,0 +1,113 @@
+#!/usr/bin/env bash
+
+#? Description:
+#?   Test shadowsocks-manager in your Python environment.
+#?   If you need to run the setup under a specific Python environment, make
+#?   sure to activate it before to run the setup.
+#?
+#? Usage:
+#?   ssm-test.sh [-t] [-c] [-g [-o OUTFILE]] [-u] [-h]
+#?
+#? Options:
+#?   [-t]
+#?
+#?   Run the test.
+#?
+#?   [-c]
+#?
+#?   Run the test with coverage.
+#?
+#?   [-g]
+#?
+#?   Generate coverage report with the previous coverage data.
+#?
+#?   [-o OUTFILE]
+#?
+#?   The output file for the coverage report.
+#?   The default is `coverage.xml`.
+#?
+#?   [-u]
+#?
+#?   Upload the coverage report to codecov.io.
+#?
+#?   [-h]
+#?
+#?   This help.
+#?
+#? Environment:
+#?   The following environment variables are used by this script:
+#?
+#?   - CODECOV_TOKEN
+#?
+#?     Required if -u is provided.
+#?
+#? Example:
+#?   # run the test without coverage, and generate coverage report, and upload it
+#?   $ ssm-test.sh -c -g -u
+#?
+
+# exit on any error
+set -e -o pipefail
+
+function usage () {
+    awk '/^#\?/ {sub("^[ ]*#\\?[ ]?", ""); print}' "$0" \
+        | awk '{gsub(/^[^ ]+.*/, "\033[1m&\033[0m"); print}'
+}
+
+function main () {
+    declare test=0 coverage=0 report=0 outfile_opt upload=0 \
+            OPTIND OPTARG opt
+
+    while getopts tcgo:u opt; do
+        case $opt in
+            t)
+                test=1
+                ;;
+            c)
+                coverage=1
+                ;;
+            g)
+                report=1
+                ;;
+            o)
+                outfile_opt=(-o "$OPTARG")
+                ;;
+            u)
+                upload=1
+                ;;
+            *)
+                usage
+                exit 255
+                ;;
+        esac
+    done
+
+    if [[ $# -eq 0 ]]; then
+        usage
+        exit 255
+    fi
+
+    # run the test
+    if [[ ${test} -eq 1 ]]; then
+        ssm-manage test --no-input -v 2
+    fi
+
+    # run the test with coverage
+    if [[ ${coverage} -eq 1 ]]; then
+        ssm coverage run manage.py test --no-input -v 2
+    fi
+
+    # generate coverage report
+    if [[ ${report} -eq 1 ]]; then
+        ssm coverage xml "${outfile_opt[@]}"
+    fi
+
+    # upload coverage report
+    if [[ ${upload} -eq 1 ]]; then
+        ssm codecovcli upload-process
+    fi
+}
+
+main "$@"
+
+exit

shadowsocks_manager/.env

@@ -0,0 +1,18 @@
+# Django settings: SECRET_KEY
+# SECURITY WARNING: keep the secret key used in production secret!
+SSM_SECRET_KEY=ef24ff499c58a21711385e8a6b31a7680fb41765b8ca0cb451
+
+# Django settings: DEBUG
+# SECURITY WARNING: don't run with debug turned on in production!
+SSM_DEBUG=True
+
+# Django settings: TIME_ZONE
+SSM_TIME_ZONE=UTC
+
+# Django settings: CACHES
+SSM_MEMCACHED_HOST=localhost
+SSM_MEMCACHED_PORT=11211
+
+# Django settings: CELERY_BROKER_URL
+SSM_RABBITMQ_HOST=localhost
+SSM_RABBITMQ_PORT=5672

shadowsocks_manager/__main__.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python
+import os
+import sys
+import subprocess
+from docopt import docopt
+
+
+def main():
+    """
+    Description:
+        Make the proxy call after adding the django root to the python path and changing the current directory to the django root.
+
+    Usage:
+        ssm COMMAND [OPTIONS]
+
+    Options:
+        COMMAND     The command to be run.
+        OPTIONS     All options are transparently passing to the called command.
+
+    Returns:
+        None
+
+    Example:
+        $ ssm python manage.py runserver
+        $ ssm uwsgi --ini uwsgi.ini
+        $ ssm celery -A shadowsocks_manager worker -l info
+    """
+    #docopt(main.__doc__)
+
+    django_root = os.path.dirname(os.path.abspath(__file__))
+
+    # add the django root to the python path to allow django commands to be run from any directory
+    if django_root not in sys.path:
+        sys.path.insert(0, django_root)
+
+    # change dir to the django root to allow the dir-sensitive commands(such as loaddata) to be run from any directory
+    os.chdir(django_root)
+
+ 
+    # make the proxy call
+    return subprocess.call(sys.argv[1:])
+
+
+if __name__ == '__main__':
+    sys.exit(main())

shadowsocks_manager/args_formatter/__init__.py

@@ -0,0 +1,74 @@
+# py2.7 and py3 compatibility imports
+from __future__ import unicode_literals
+from builtins import range
+from builtins import object
+from functools import reduce
+
+
+class Formatter(object):
+    """
+    Return the input-syntax string presentation of args and kwargs list, delimited by comma `, `.
+    The value of the args and kwargs are formatted as the canonical string presentation.
+
+    Usage:
+        >>> f = Formatter(*args, **kwargs)
+        >>> print(f)
+
+    Example:
+        >>> print(Formatter('foo', 1, x='bar', y=2))
+        'foo', 1, x='bar', y=2
+
+    Use Case:
+        # log the input arguments of methods.
+        def foo(*args, **kwargs):
+            message = Formatter(*args, **kwargs).to_string())
+            logger.debug('foo: {}'.format(message))
+    """
+
+    def __init__(self, *args, **kwargs):
+        """
+        Initialize the Formatter to have two members: args, kwargs
+        """
+        self.args = args
+        self.kwargs = kwargs
+
+    def __str__(self, *args, **kwargs):
+        return self.to_string(*args, **kwargs)
+
+    def args_to_string(self):
+        """
+        Return the canonical string presentation of args list, delimited by comma `, `.
+        """
+        if self.args:
+            self.args = [repr(arg) for arg in self.args]
+            formatter = ['{}' for count in range(len(self.args))]
+            return ', '.join(formatter).format(*self.args)
+
+
+    def kwargs_to_string(self):
+        """
+        Return the input-syntax string presentation of kwargs list, delimited by comma `, `.
+        The value of the kwargs are formatted as the canonical string presentation.
+        """
+        if self.kwargs:
+            formatter = ['{}={}' for count in range(len(self.kwargs))]
+            return ', '.join(formatter).format(
+                *reduce((lambda x, y: x + y), [list([k, repr(v)]) for k,v in list(self.kwargs.items())]))
+
+    def to_string(self):
+        """
+        Return the input-syntax string presentation of args and kwargs list, delimited by comma `, `.
+        The value of the args and kwargs are formatted as the canonical string presentation.
+        Be noted to the differences:
+            * An empty string `` is returned if no args and kwargs found.
+            * The input empty string `` is returned as the literal "``" with the additional quoting.
+            * The input NoneType None is returned as the literal `None` without additional quoting.
+
+        Example:
+            >>> Formatter('foo', 1, x='bar', y=2).to_string()
+            "'foo', 1, x='bar', y=2"
+        """
+
+        items = [self.args_to_string(), self.kwargs_to_string()]
+        items = [item for item in items if item is not None]
+        return ', '.join(items)

shadowsocks_manager/args_formatter/tests.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+
+# py2.7 and py3 compatibility imports
+from __future__ import unicode_literals
+from __future__ import absolute_import
+from builtins import str
+
+from unittest import TestCase
+
+from . import Formatter
+
+# Create your tests here.
+class FormatterTestCase(TestCase):
+    def test(self):
+        # no args and kwargs
+        self.assertEqual(Formatter().to_string(), '')
+        # one arg as None
+        self.assertEqual(Formatter(None).to_string(), 'None')
+        # one arg as empty string
+        self.assertEqual(Formatter('').to_string(), repr(''))
+        # two simple args
+        self.assertEqual(Formatter('foo', 1).to_string(), '{}, 1'.format(repr('foo')))
+        # one arg as list
+        self.assertEqual(Formatter(['foo', 1]).to_string(), '[{}, 1]'.format(repr('foo')))
+        # one arg as dict
+        self.assertEqual(Formatter({'foo': 1}).to_string(), repr({'foo': 1}))
+        # on arg as tuple
+        self.assertEqual(Formatter(('foo', 1)).to_string(), repr(('foo', 1)))
+        # two simple kwargs, take care of the order, so works with both py2 and py3
+        self.assertEqual(Formatter(y=2, x='bar').to_string(), 'y=2, x={}'.format(repr('bar')))
+        # one kwarg as list
+        self.assertEqual(Formatter(x=['bar', 2]).to_string(), 'x={}'.format(repr(['bar', 2])))
+        # one kwarg as dict
+        self.assertEqual(Formatter(x={'bar': 2}).to_string(), 'x={}'.format(repr({'bar': 2})))
+        # one kwarg as tuple
+        self.assertEqual(Formatter(x=('bar', 2)).to_string(), 'x={}'.format(repr(('bar', 2))))
+        # two simple args and two simple kwargs, take care of the order, so works with both py2 and py3
+        self.assertEqual(
+            Formatter('foo', 1, y=2, x='bar').to_string(),
+            '{}, 1, y=2, x={}'.format(repr('foo'), repr('bar')))
+        # __str__()
+        self.assertEqual(str(Formatter(None)), 'None')

shadowsocks_manager/domain/admin.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+
+# py2.7 and py3 compatibility imports
+from __future__ import unicode_literals
+
+import json
+from django.contrib import admin, messages
+
+from .models import NameServer, Domain, Record
+
+
+# Register your models here.
+
+@admin.register(NameServer)
+class NameServerAdmin(admin.ModelAdmin):
+    fields = ('name', 'api_cls_name', 'user', 'credential',
+                  'dt_created', 'dt_updated')
+
+    readonly_fields = ('dt_created', 'dt_updated')
+
+    list_display = ('name', 'api_cls_name', 'user', 'is_api_accessible',
+                        'dt_created', 'dt_updated')
+
+    def is_api_accessible(self, obj):
+        return obj.is_api_accessible
+
+    is_api_accessible.boolean = True
+    is_api_accessible.short_description = 'API'
+
+
+@admin.register(Domain)
+class DomainAdmin(admin.ModelAdmin):
+    fields = ('name', 'nameserver',
+                  'dt_created', 'dt_updated')
+
+    readonly_fields = ('dt_created', 'dt_updated')
+
+    list_display = ('name', 'nameserver',
+                        'dt_created', 'dt_updated')
+
+
+@admin.register(Record)
+class RecordAdmin(admin.ModelAdmin):
+    fields = ('host', 'domain', 'type', 'answer', 'site',
+                  'dt_created', 'dt_updated')
+
+    readonly_fields = ('dt_created', 'dt_updated')
+
+    list_display = ('host', 'domain', 'type', 'answer', 'answer_from_dns_api', 'is_matching_dns_api',
+                        'answer_from_dns_query', 'is_matching_dns_query', 'site',
+                        'dt_created', 'dt_updated')
+
+    def answer_from_dns_api(self, obj):
+        return list(obj.answer_from_dns_api) if obj.answer_from_dns_api is not None else obj.answer_from_dns_api
+
+    def answer_from_dns_query(self, obj):
+        return list(obj.answer_from_dns_query) if obj.answer_from_dns_query is not None else obj.answer_from_dns_query
+
+    def is_matching_dns_api(self, obj):
+        return obj.is_matching_dns_api
+
+    is_matching_dns_api.boolean = True
+    is_matching_dns_api.short_description = 'DNS API'
+
+    def is_matching_dns_query(self, obj):
+        return obj.is_matching_dns_query
+
+    is_matching_dns_query.boolean = True
+    is_matching_dns_query.short_description = 'DNS Query'
+
+    def sync_to_dns(self, request, queryset):
+        for obj in queryset:
+            result = obj.sync_to_dns()
+            messages.info(request, '{0}: {1}'.format(obj.host, json.dumps(result)))
+
+    sync_to_dns.short_description = 'Synchronize DNS records to DNS server for Selected Domain'
+
+    actions = (sync_to_dns,)

shadowsocks_manager/domain/apps.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+
+# py2.7 and py3 compatibility imports
+from __future__ import unicode_literals
+
+from django.apps import AppConfig
+
+
+class DomainConfig(AppConfig):
+    name = 'domain'

shadowsocks_manager/domain/fixtures/nameserver.json

@@ -0,0 +1 @@
+[{"model": "domain.nameserver", "pk": 1, "fields": {"name": "name.com", "api_cls_name": "NameNsApi", "user": null, "credential": null, "dt_created": "2021-01-12T16:58:21.432Z", "dt_updated": "2021-01-14T12:25:28.865Z"}}]