Merge pull request #38 from ralphwetzel/devel

Preparation for 4.1

LICENSE

@@ -1,22 +1,22 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 ralphwetzel
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+The MIT License (MIT)
+
+Copyright (c) 2015 - 2018 ralphwetzel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

setup.py

@@ -1,26 +1,279 @@
-from setuptools import setup, find_packages
-# from distutils.core import setup
-
-setup(
-        name='theonionbox',
-        version='0.0.1.dev3',
-        packages=['theonionbox'],
-#         package_dir={'theonionbox': 'theonionbox'},
-#         package_data={'theonionbox': ['config/theonionbox.cfg',
-#                                       'pages/*.html',
-#                                       'css/*.css',
-#                                       'scripts/*.js']},
-#        packages=find_packages(),
-        include_package_data=True,
-#         zip_safe=False,
-        url='https://github.com/ralphwetzel/theonionbox',
-        license='MIT',
-        author='Ralph Wetzel',
-        author_email='theonionbox@gmx.com',
-        description='Web Interface for TOR relay',
-        install_requires=[
-            'psutil',
-            'stem',
-            'bottle>=0.12.8',
-        ]
-)
+from setuptools import setup
+import os
+import sys
+import fnmatch
+import setuptools.command.sdist
+import setuptools.command.install
+from theonionbox.stamp import __version__, __description__
+
+# Custom command to compile the latest README.html, linked into the sdist chain
+# https://seasonofcode.com/posts/how-to-add-custom-build-steps-and-commands-to-setuppy.html
+# BTW: grip is quite cool!
+class CompileREADMECommand(setuptools.command.sdist.sdist):
+
+    def run(self):
+
+        # https://stackoverflow.com/questions/3431825/generating-an-md5-checksum-of-a-file
+        def get_hash(filename):
+
+            import hashlib
+
+            def hash_bytestr_iter(bytesiter, hasher, ashexstr=False):
+                for block in bytesiter:
+                    hasher.update(block)
+                return (hasher.hexdigest() if ashexstr else hasher.digest())
+
+            def file_as_blockiter(afile, blocksize=65536):
+                with afile:
+                    block = afile.read(blocksize)
+                    while len(block) > 0:
+                        yield block
+                        block = afile.read(blocksize)
+
+            return hash_bytestr_iter(file_as_blockiter(open(filename, 'rb')), hashlib.sha256(), True)
+
+        old_md_hash = ''
+        old_html_hash = ''
+        old_rst_hash = ''
+
+        current_md_hash = 'doit'
+        current_html_hash = 'doit'
+        current_rst_hash = 'doit'
+
+        try:
+            with open('docs/README.hash', 'r') as f:
+                lines = f.readlines()
+                if len(lines) == 3:
+                    old_md_hash = lines[0].strip()
+                    old_html_hash = lines[1].strip()
+                    old_rst_hash = lines[2].strip()
+        except Exception as e:
+            # raise e
+            pass
+
+        try:
+            current_md_hash = get_hash('README.md')
+            current_html_hash = get_hash('docs/README.html')
+            current_rst_hash = get_hash('docs/README.rst')
+        except Exception as e:
+            # raise e
+            pass
+
+        hash_changed = False
+
+        if (old_md_hash != current_md_hash) or (old_html_hash != current_html_hash):
+            from grip import export
+            export(path='README.md', out_filename='docs/README.html', title='The Onion Box v{}'.format(__version__))
+            hash_changed = True
+        else:
+            print('Skiping generation of README.html; files unchanged!')
+
+        do_rst = False
+        if do_rst is True:
+            if (old_md_hash != current_md_hash) or (old_rst_hash != current_rst_hash):
+                # path defined by: brew install pandoc
+                # os.environ.setdefault('PYPANDOC_PANDOC', '/usr/local/Cellar/pandoc/2.1')
+                from pypandoc import convert_file
+                print('Generating README.rst')
+                convert_file('README.md', 'rst', outputfile="docs/README.rst")
+                hash_changed = True
+            else:
+                print('Skiping generation of README.rst; files unchanged!')
+        else:
+            print('Generation of README.rst intentionally deactivated!')
+
+        if hash_changed is True:
+            with open('docs/README.hash', 'w') as f:
+                f.write(current_md_hash+'\n'+current_html_hash+'\n'+current_rst_hash)
+
+        # continue with standard staff...
+        setuptools.command.sdist.sdist.run(self)
+
+
+# class PostInstallCommand(setuptools.command.install.install):
+#
+#     def run(self):
+#         import os
+#         # start with standard staff...
+#         setuptools.command.install.install.run(self)
+#
+#         # post install activities
+#         # http://stackoverflow.com/a/1883251/1286571
+#         import sys
+#         if hasattr(sys, 'real_prefix'):
+#             os.chmod('theonionbox/theonionbox/run.sh', int('755', 8))
+#         else:
+#             print("No real_prefix")
+
+
+def generate_package_data(package_data, package_dir=None):
+    """
+    :param package_data: package_data as expected by setup.py, recursive dir wildcards
+    :type package_data: dict
+    :param package_dir: package_dir as expected by setup.py
+    :type package_dir: dict
+    :return: package_data as expected by setup.py, recursive directories expanded
+    :rtype: dict
+    """
+
+    out = {}
+
+    package_dir = package_dir or {}
+
+    for key, paths in package_data.items():
+        out_path = []
+
+        base_path = package_dir[key] if key in package_dir else ''
+
+        for path_item in paths:
+            root = os.path.join(base_path, path_item)
+
+            if os.path.isfile(root):
+                out_path.append(path_item)
+                continue
+
+            root_dir, root_file = os.path.split(root)
+
+            for (dirpath, dirnames, filenames) in os.walk(root_dir):
+                out_path.append(os.path.relpath(os.path.join(dirpath, root_file), base_path))
+
+        out[key] = out_path
+
+    return out
+
+
+def generate_data_files(data_files):
+    """
+    :param data_files: data_files as expected by setup.py, recursive dir wildcards
+    :type package_data: list
+    :return: data_files as expected by setup.py, recursive files expanded
+    :rtype: list
+    """
+
+    out = {}
+
+    for target, sources in data_files:
+
+        if target not in out:
+            out[target] = []
+
+        for source in sources:
+
+            if os.path.isfile(source):
+                out[target].append(source)
+                continue
+
+            source_dir, source_match = os.path.split(source)
+
+            for (dirpath, dirnames, filenames) in os.walk(source_dir):
+                    for file in filenames:
+                        if fnmatch.fnmatch(file, source_match):
+                            file_rel_target = os.path.relpath(dirpath, source_dir)
+                            file_target = os.path.join(target, file_rel_target)
+
+                            if file_target not in out:
+                                out[file_target] = []
+
+                            out[file_target].append(os.path.join(dirpath, file))
+
+    retval = []
+    for key, items in out.items():
+        retval.append((key, items))
+
+    return retval
+
+
+packages = [
+    'theonionbox',
+    'theonionbox.tob',
+    'theonionbox.tob.external',
+    # 'theonionbox.tob.external.tzlocal'
+]
+
+package_dir = {
+    'theonionbox': 'theonionbox',
+    'theonionbox.tob': 'theonionbox/tob',
+    'theonionbox.tob.external': 'theonionbox/tob/external',
+    # 'theonionbox.tob.external.tzlocal:': 'theonionbox/tob/external/tzlocal'
+}
+
+package_data = {
+    'theonionbox': ['bootstrap/*.*',
+                    'config/*.*',
+                    'css/*.*',
+                    'font/*.*',
+                    'pages/*.*',
+                    'scripts/*.*',
+                    'sections/*.*',
+                    'tor/*.*',
+                    'uptime/*.*',
+                    ]
+}
+
+data_files = [
+    ('docs', ['docs/*.*']),
+    ('', ['README.html', 'theonionbox/run.py']),
+    ('config', ['theonionbox/config/*.*']),
+    ('service', []),
+    ('service/FreeBSD', ['FreeBSD/theonionbox.sh']),
+    ('service/init.d', ['init.d/theonionbox.sh']),
+    ('service/systemd', ['systemd/theonionbox.service']),
+]
+# print(generate_data_files(data_files))
+
+setup(
+    cmdclass={'sdist': CompileREADMECommand,
+              },
+    name='theonionbox',
+    version=__version__,
+    # py_modules=['theonionbox.py'],
+    packages=packages,
+    package_dir=package_dir,
+    package_data=generate_package_data(package_data, package_dir),
+    data_files=generate_data_files(data_files),
+    url='https://github.com/ralphwetzel/theonionbox',
+    license='MIT',
+    author='Ralph Wetzel',
+    author_email='theonionbox@gmx.com',
+    description=__description__,
+    long_description=open('docs/README_Intro.rst').read(),
+    entry_points={
+        'console_scripts': [
+            'theonionbox = theonionbox.__main__:main']
+    },
+    install_requires=[
+        'psutil',
+        'apscheduler>=2.1.2, <3.*; python_version<"3.0"',
+        'apscheduler>=3.4; python_version>="3.0"',
+        'requests>2.18',
+        'PySocks>=1.6.7',
+        'bottle>=0.12.13',
+        'stem>=1.5.4',
+        'tzlocal>=1.5',
+        'futures>=3.2; python_version<"3.0"'
+    ],
+    long_description_content_type='text/x-rst; charset=UTF-8',
+    classifiers=[
+        # https://pypi.python.org/pypi?%3Aaction=list_classifiers
+        'Development Status :: 5 - Production/Stable',
+        'Environment :: Console',
+        'Environment :: Web Environment',
+        'Framework :: Bottle',
+        'Intended Audience :: End Users/Desktop',
+        'Intended Audience :: Information Technology',
+        'Intended Audience :: Science/Research',
+        'Intended Audience :: System Administrators',
+        'License :: OSI Approved :: MIT License',
+        'Natural Language :: English',
+        'Operating System :: MacOS',
+        'Operating System :: Microsoft :: Windows',
+        'Operating System :: POSIX :: BSD :: FreeBSD',
+        'Operating System :: POSIX :: Linux',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Topic :: System :: Networking :: Monitoring',
+        'Topic :: Utilities',
+    ],
+    platforms=['Linux', 'Windows', 'MacOS X', 'FreeBSD']
+)

theonionbox/__main__.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python
+import sys
+
+
+def main():
+
+    # the import executes the scripting part...
+    import theonionbox
+    # ... and main() launches the server!
+    theonionbox.main()
+
+
+if __name__ == "__main__":
+
+    args = sys.argv[1:]
+    main()
+
+

theonionbox/config/theonionbox.example

@@ -218,7 +218,7 @@ protocol = 2
 # socket = /var/run/tor/control
 ## Note: There is no default setting.
 
-## Hidden Service connections my be secured by definition of a authorization cookie.
+## Hidden Service connections may be secured by definition of a authorization cookie.
 ## To operate via those connections, you may define this cookie here.
 ## For further details refer to 'HiddenServiceAuthorizeClient' on https://www.torproject.org/docs/tor-manual.html
 # cookie = xuseyourcookieherexTOB