From 4cc1dc405f31d3db36a20e6db0816f155d0c9144 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Sun, 22 Jun 2014 01:06:39 +0200 Subject: [PATCH 01/24] v1.1.0-rc1 --- VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VERSION b/VERSION index 336c3677..8376431e 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.1.0-dev +1.1.0-rc1 From f693f26ffc0d6b92394e8f58d34cb33ebef54f9c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Sat, 21 Jun 2014 20:16:53 +0200 Subject: [PATCH 02/24] Insert src folder at first position of sys.path (cherry picked from commit fa564c6) --- run | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/run b/run index 35ebbef8..0c51da39 100755 --- a/run +++ b/run @@ -16,7 +16,7 @@ I don't know anything about). """ os.rename(old, os.path.join(basedir, "octoprint.backup")) -sys.path.append(os.path.join(basedir, "src")) +sys.path.insert(0, os.path.join(basedir, "src")) import octoprint octoprint.main() From 18162cf11051febc9a1770befc2b052d9468c252 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Sun, 22 Jun 2014 00:41:03 +0200 Subject: [PATCH 03/24] Versioning by versioneer: https://github.com/warner/python-versioneer/ (cherry picked from commit 285f464) --- .gitattributes | 1 + MANIFEST.in | 2 + setup.py | 10 + src/octoprint/__init__.py | 15 +- src/octoprint/_version.py | 188 ++++++ src/octoprint/server/__init__.py | 16 +- src/octoprint/templates/index.jinja2 | 8 +- versioneer.py | 899 +++++++++++++++++++++++++++ 8 files changed, 1124 insertions(+), 15 deletions(-) create mode 100644 .gitattributes create mode 100644 src/octoprint/_version.py create mode 100644 versioneer.py diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..6e546346 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +src/octoprint/_version.py export-subst diff --git a/MANIFEST.in b/MANIFEST.in index d47da275..8373cd4d 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,4 @@ recursive-include src/octoprint/static * recursive-include src/octoprint/templates * +include versioneer.py +include src/octoprint/_version.py diff --git a/setup.py b/setup.py index 5c407bc0..1dc91f38 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,13 @@ # coding=utf-8 #!/usr/bin/env python +import versioneer +versioneer.VCS = 'git' +versioneer.versionfile_source = 'src/octoprint/_version.py' +versioneer.versionfile_build = 'octoprint/_version.py' +versioneer.tag_prefix = '' +versioneer.parentdir_prefix = 'octoprint-' + from setuptools import setup, find_packages VERSION = open("VERSION").read().strip() @@ -51,6 +58,9 @@ def params(): # "scripts/octoprint.init": "/etc/init.d/octoprint" #} + version = versioneer.get_version() + cmdclass = versioneer.get_cmdclass() + return locals() setup(**params()) diff --git a/src/octoprint/__init__.py b/src/octoprint/__init__.py index dbd06e7d..1258ed84 100644 --- a/src/octoprint/__init__.py +++ b/src/octoprint/__init__.py @@ -3,6 +3,13 @@ import sys from octoprint.daemon import Daemon from octoprint.server import Server +#~~ version + +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions + +#~~ main class class Main(Daemon): def __init__(self, pidfile, configfile, basedir, host, port, debug, allowRoot): @@ -24,6 +31,9 @@ def main(): parser = argparse.ArgumentParser(prog="run") + parser.add_argument("-v", "--version", action="store_true", dest="version", + help="Output OctoPrint's version and exit") + parser.add_argument("-d", "--debug", action="store_true", dest="debug", help="Enable debug mode") @@ -47,6 +57,10 @@ def main(): args = parser.parse_args() + if args.version: + print "OctoPrint version %s" % __version__ + sys.exit(0) + if args.daemon: if sys.platform == "darwin" or sys.platform == "win32": print >> sys.stderr, "Sorry, daemon mode is only supported under Linux right now" @@ -65,4 +79,3 @@ def main(): if __name__ == "__main__": main() - diff --git a/src/octoprint/_version.py b/src/octoprint/_version.py new file mode 100644 index 00000000..f9a41364 --- /dev/null +++ b/src/octoprint/_version.py @@ -0,0 +1,188 @@ + +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (build by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.10 (https://github.com/warner/python-versioneer) + +# these strings will be replaced by git during git-archive +git_refnames = "$Format:%d$" +git_full = "$Format:%H$" + + +import subprocess +import sys +import errno + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): + assert isinstance(commands, list) + p = None + for c in commands: + try: + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % args[0]) + print(e) + return None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None + stdout = p.communicate()[0].strip() + if sys.version >= '3': + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % args[0]) + return None + return stdout + + +import sys +import re +import os.path + +def get_expanded_variables(versionfile_abs): + # the code embedded in _version.py can just fetch the value of these + # variables. When used from setup.py, we don't want to import + # _version.py, so we do it with a regexp instead. This function is not + # used from _version.py. + variables = {} + try: + f = open(versionfile_abs,"r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["full"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return variables + +def versions_from_expanded_variables(variables, tag_prefix, verbose=False): + refnames = variables["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("variables are unexpanded, not using") + return {} # unexpanded, so not in an unpacked git-archive tarball + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs-tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return { "version": r, + "full": variables["full"].strip() } + # no suitable tags, so we use the full revision id + if verbose: + print("no suitable tags, using full revision id") + return { "version": variables["full"].strip(), + "full": variables["full"].strip() } + +def versions_from_vcs(tag_prefix, root, verbose=False): + # this runs 'git' from the root of the source tree. This only gets called + # if the git-archive 'subst' variables were *not* expanded, and + # _version.py hasn't already been rewritten with a short version string, + # meaning we're inside a checked out source tree. + + if not os.path.exists(os.path.join(root, ".git")): + if verbose: + print("no .git in %s" % root) + return {} + + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + stdout = run_command(GITS, ["describe", "--tags", "--dirty", "--always"], + cwd=root) + if stdout is None: + return {} + if not stdout.startswith(tag_prefix): + if verbose: + print("tag '%s' doesn't start with prefix '%s'" % (stdout, tag_prefix)) + return {} + tag = stdout[len(tag_prefix):] + stdout = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if stdout is None: + return {} + full = stdout.strip() + if tag.endswith("-dirty"): + full += "-dirty" + return {"version": tag, "full": full} + + +def versions_from_parentdir(parentdir_prefix, root, verbose=False): + # Source tarballs conventionally unpack into a directory that includes + # both the project name and a version string. + dirname = os.path.basename(root) + if not dirname.startswith(parentdir_prefix): + if verbose: + print("guessing rootdir is '%s', but '%s' doesn't start with prefix '%s'" % + (root, dirname, parentdir_prefix)) + return None + return {"version": dirname[len(parentdir_prefix):], "full": ""} + +tag_prefix = "" +parentdir_prefix = "octoprint-" +versionfile_source = "src/octoprint/_version.py" + +def get_versions(default={"version": "unknown", "full": ""}, verbose=False): + # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have + # __file__, we can work backwards from there to the root. Some + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded variables. + + variables = { "refnames": git_refnames, "full": git_full } + ver = versions_from_expanded_variables(variables, tag_prefix, verbose) + if ver: + return ver + + try: + root = os.path.abspath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in range(len(versionfile_source.split("/"))): + root = os.path.dirname(root) + except NameError: + return default + + return (versions_from_vcs(tag_prefix, root, verbose) + or versions_from_parentdir(parentdir_prefix, root, verbose) + or default) + diff --git a/src/octoprint/server/__init__.py b/src/octoprint/server/__init__.py index 51bf09f9..28f186cc 100644 --- a/src/octoprint/server/__init__.py +++ b/src/octoprint/server/__init__.py @@ -38,17 +38,14 @@ import octoprint.util as util import octoprint.users as users import octoprint.events as events import octoprint.timelapse +import octoprint._version + + +VERSION = octoprint._version.get_versions()['version'] @app.route("/") def index(): - branch = None - commit = None - try: - branch, commit = util.getGitInfo() - except: - pass - return render_template( "index.jinja2", webcamStream=settings().get(["webcam", "stream"]), @@ -60,8 +57,7 @@ def index(): enableSdSupport=settings().get(["feature", "sdSupport"]), firstRun=settings().getBoolean(["server", "firstRun"]) and (userManager is None or not userManager.hasBeenCustomized()), debug=debug, - gitBranch=branch, - gitCommit=commit, + version=VERSION, stylesheet=settings().get(["devel", "stylesheet"]), gcodeMobileThreshold=settings().get(["gcodeViewer", "mobileSizeThreshold"]), gcodeThreshold=settings().get(["gcodeViewer", "sizeThreshold"]) @@ -130,6 +126,8 @@ class Server(): self._initLogging(self._debug) logger = logging.getLogger(__name__) + logger.info("Starting OctoPrint (%s)" % VERSION) + eventManager = events.eventManager() gcodeManager = gcodefiles.GcodeManager() printer = Printer(gcodeManager) diff --git a/src/octoprint/templates/index.jinja2 b/src/octoprint/templates/index.jinja2 index cf323a0b..fa5ebe7b 100644 --- a/src/octoprint/templates/index.jinja2 +++ b/src/octoprint/templates/index.jinja2 @@ -596,11 +596,9 @@
- {% if gitBranch and gitCommit %} -
    -
  • Branch: {{ gitBranch }}, Commit: {{ gitCommit }}
    • -
- {% endif %} +
    +
  • Version: {{ version }}
    • +
  • Homepage
  • Sourcecode
    • diff --git a/versioneer.py b/versioneer.py new file mode 100644 index 00000000..b7e37ae2 --- /dev/null +++ b/versioneer.py @@ -0,0 +1,899 @@ + +# Version: 0.10 + +""" +The Versioneer +============== + +* like a rocketeer, but for versions! +* https://github.com/warner/python-versioneer +* Brian Warner +* License: Public Domain +* Compatible With: python2.6, 2.7, and 3.2, 3.3 + +[![Build Status](https://travis-ci.org/warner/python-versioneer.png?branch=master)](https://travis-ci.org/warner/python-versioneer) + +This is a tool for managing a recorded version number in distutils-based +python projects. The goal is to remove the tedious and error-prone "update +the embedded version string" step from your release process. Making a new +release should be as easy as recording a new tag in your version-control +system, and maybe making new tarballs. + + +## Quick Install + +* `pip install versioneer` to somewhere to your $PATH +* run `versioneer-installer` in your source tree: this installs `versioneer.py` +* follow the instructions below (also in the `versioneer.py` docstring) + +## Version Identifiers + +Source trees come from a variety of places: + +* a version-control system checkout (mostly used by developers) +* a nightly tarball, produced by build automation +* a snapshot tarball, produced by a web-based VCS browser, like github's + "tarball from tag" feature +* a release tarball, produced by "setup.py sdist", distributed through PyPI + +Within each source tree, the version identifier (either a string or a number, +this tool is format-agnostic) can come from a variety of places: + +* ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows + about recent "tags" and an absolute revision-id +* the name of the directory into which the tarball was unpacked +* an expanded VCS variable ($Id$, etc) +* a `_version.py` created by some earlier build step + +For released software, the version identifier is closely related to a VCS +tag. Some projects use tag names that include more than just the version +string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool +needs to strip the tag prefix to extract the version identifier. For +unreleased software (between tags), the version identifier should provide +enough information to help developers recreate the same tree, while also +giving them an idea of roughly how old the tree is (after version 1.2, before +version 1.3). Many VCS systems can report a description that captures this, +for example 'git describe --tags --dirty --always' reports things like +"0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the +0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has +uncommitted changes. + +The version identifier is used for multiple purposes: + +* to allow the module to self-identify its version: `myproject.__version__` +* to choose a name and prefix for a 'setup.py sdist' tarball + +## Theory of Operation + +Versioneer works by adding a special `_version.py` file into your source +tree, where your `__init__.py` can import it. This `_version.py` knows how to +dynamically ask the VCS tool for version information at import time. However, +when you use "setup.py build" or "setup.py sdist", `_version.py` in the new +copy is replaced by a small static file that contains just the generated +version data. + +`_version.py` also contains `$Revision$` markers, and the installation +process marks `_version.py` to have this marker rewritten with a tag name +during the "git archive" command. As a result, generated tarballs will +contain enough information to get the proper version. + + +## Installation + +First, decide on values for the following configuration variables: + +* `versionfile_source`: + + A project-relative pathname into which the generated version strings should + be written. This is usually a `_version.py` next to your project's main + `__init__.py` file. If your project uses `src/myproject/__init__.py`, this + should be `src/myproject/_version.py`. This file should be checked in to + your VCS as usual: the copy created below by `setup.py versioneer` will + include code that parses expanded VCS keywords in generated tarballs. The + 'build' and 'sdist' commands will replace it with a copy that has just the + calculated version string. + +* `versionfile_build`: + + Like `versionfile_source`, but relative to the build directory instead of + the source directory. These will differ when your setup.py uses + 'package_dir='. If you have `package_dir={'myproject': 'src/myproject'}`, + then you will probably have `versionfile_build='myproject/_version.py'` and + `versionfile_source='src/myproject/_version.py'`. + +* `tag_prefix`: + + a string, like 'PROJECTNAME-', which appears at the start of all VCS tags. + If your tags look like 'myproject-1.2.0', then you should use + tag_prefix='myproject-'. If you use unprefixed tags like '1.2.0', this + should be an empty string. + +* `parentdir_prefix`: + + a string, frequently the same as tag_prefix, which appears at the start of + all unpacked tarball filenames. If your tarball unpacks into + 'myproject-1.2.0', this should be 'myproject-'. + +This tool provides one script, named `versioneer-installer`. That script does +one thing: write a copy of `versioneer.py` into the current directory. + +To versioneer-enable your project: + +* 1: Run `versioneer-installer` to copy `versioneer.py` into the top of your + source tree. + +* 2: add the following lines to the top of your `setup.py`, with the + configuration values you decided earlier: + + import versioneer + versioneer.versionfile_source = 'src/myproject/_version.py' + versioneer.versionfile_build = 'myproject/_version.py' + versioneer.tag_prefix = '' # tags are like 1.2.0 + versioneer.parentdir_prefix = 'myproject-' # dirname like 'myproject-1.2.0' + +* 3: add the following arguments to the setup() call in your setup.py: + + version=versioneer.get_version(), + cmdclass=versioneer.get_cmdclass(), + +* 4: now run `setup.py versioneer`, which will create `_version.py`, and + will modify your `__init__.py` to define `__version__` (by calling a + function from `_version.py`). It will also modify your `MANIFEST.in` to + include both `versioneer.py` and the generated `_version.py` in sdist + tarballs. + +* 5: commit these changes to your VCS. To make sure you won't forget, + `setup.py versioneer` will mark everything it touched for addition. + +## Post-Installation Usage + +Once established, all uses of your tree from a VCS checkout should get the +current version string. All generated tarballs should include an embedded +version string (so users who unpack them will not need a VCS tool installed). + +If you distribute your project through PyPI, then the release process should +boil down to two steps: + +* 1: git tag 1.0 +* 2: python setup.py register sdist upload + +If you distribute it through github (i.e. users use github to generate +tarballs with `git archive`), the process is: + +* 1: git tag 1.0 +* 2: git push; git push --tags + +Currently, all version strings must be based upon a tag. Versioneer will +report "unknown" until your tree has at least one tag in its history. This +restriction will be fixed eventually (see issue #12). + +## Version-String Flavors + +Code which uses Versioneer can learn about its version string at runtime by +importing `_version` from your main `__init__.py` file and running the +`get_versions()` function. From the "outside" (e.g. in `setup.py`), you can +import the top-level `versioneer.py` and run `get_versions()`. + +Both functions return a dictionary with different keys for different flavors +of the version string: + +* `['version']`: condensed tag+distance+shortid+dirty identifier. For git, + this uses the output of `git describe --tags --dirty --always` but strips + the tag_prefix. For example "0.11-2-g1076c97-dirty" indicates that the tree + is like the "1076c97" commit but has uncommitted changes ("-dirty"), and + that this commit is two revisions ("-2-") beyond the "0.11" tag. For + released software (exactly equal to a known tag), the identifier will only + contain the stripped tag, e.g. "0.11". + +* `['full']`: detailed revision identifier. For Git, this is the full SHA1 + commit id, followed by "-dirty" if the tree contains uncommitted changes, + e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac-dirty". + +Some variants are more useful than others. Including `full` in a bug report +should allow developers to reconstruct the exact code being tested (or +indicate the presence of local changes that should be shared with the +developers). `version` is suitable for display in an "about" box or a CLI +`--version` output: it can be easily compared against release notes and lists +of bugs fixed in various releases. + +In the future, this will also include a +[PEP-0440](http://legacy.python.org/dev/peps/pep-0440/) -compatible flavor +(e.g. `1.2.post0.dev123`). This loses a lot of information (and has no room +for a hash-based revision id), but is safe to use in a `setup.py` +"`version=`" argument. It also enables tools like *pip* to compare version +strings and evaluate compatibility constraint declarations. + +The `setup.py versioneer` command adds the following text to your +`__init__.py` to place a basic version in `YOURPROJECT.__version__`: + + from ._version import get_versions + __version = get_versions()['version'] + del get_versions + +## Updating Versioneer + +To upgrade your project to a new release of Versioneer, do the following: + +* install the new Versioneer (`pip install -U versioneer` or equivalent) +* re-run `versioneer-installer` in your source tree to replace `versioneer.py` +* edit `setup.py`, if necessary, to include any new configuration settings indicated by the release notes +* re-run `setup.py versioneer` to replace `SRC/_version.py` +* commit any changed files + +## Future Directions + +This tool is designed to make it easily extended to other version-control +systems: all VCS-specific components are in separate directories like +src/git/ . The top-level `versioneer.py` script is assembled from these +components by running make-versioneer.py . In the future, make-versioneer.py +will take a VCS name as an argument, and will construct a version of +`versioneer.py` that is specific to the given VCS. It might also take the +configuration arguments that are currently provided manually during +installation by editing setup.py . Alternatively, it might go the other +direction and include code from all supported VCS systems, reducing the +number of intermediate scripts. + + +## License + +To make Versioneer easier to embed, all its code is hereby released into the +public domain. The `_version.py` that it creates is also in the public +domain. + +""" + +import os, sys, re +from distutils.core import Command +from distutils.command.sdist import sdist as _sdist +from distutils.command.build import build as _build +from distutils.command.build_py import build_py as _build_py + +versionfile_source = None +versionfile_build = None +tag_prefix = None +parentdir_prefix = None + +VCS = "git" + + +LONG_VERSION_PY = ''' +# This file helps to compute a version number in source trees obtained from +# git-archive tarball (such as those provided by githubs download-from-tag +# feature). Distribution tarballs (build by setup.py sdist) and build +# directories (produced by setup.py build) will contain a much shorter file +# that just contains the computed version number. + +# This file is released into the public domain. Generated by +# versioneer-0.10 (https://github.com/warner/python-versioneer) + +# these strings will be replaced by git during git-archive +git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" +git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" + + +import subprocess +import sys +import errno + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): + assert isinstance(commands, list) + p = None + for c in commands: + try: + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %%s" %% args[0]) + print(e) + return None + else: + if verbose: + print("unable to find command, tried %%s" %% (commands,)) + return None + stdout = p.communicate()[0].strip() + if sys.version >= '3': + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %%s (error)" %% args[0]) + return None + return stdout + + +import sys +import re +import os.path + +def get_expanded_variables(versionfile_abs): + # the code embedded in _version.py can just fetch the value of these + # variables. When used from setup.py, we don't want to import + # _version.py, so we do it with a regexp instead. This function is not + # used from _version.py. + variables = {} + try: + f = open(versionfile_abs,"r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["full"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return variables + +def versions_from_expanded_variables(variables, tag_prefix, verbose=False): + refnames = variables["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("variables are unexpanded, not using") + return {} # unexpanded, so not in an unpacked git-archive tarball + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %%d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%%s', no digits" %% ",".join(refs-tags)) + if verbose: + print("likely tags: %%s" %% ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %%s" %% r) + return { "version": r, + "full": variables["full"].strip() } + # no suitable tags, so we use the full revision id + if verbose: + print("no suitable tags, using full revision id") + return { "version": variables["full"].strip(), + "full": variables["full"].strip() } + +def versions_from_vcs(tag_prefix, root, verbose=False): + # this runs 'git' from the root of the source tree. This only gets called + # if the git-archive 'subst' variables were *not* expanded, and + # _version.py hasn't already been rewritten with a short version string, + # meaning we're inside a checked out source tree. + + if not os.path.exists(os.path.join(root, ".git")): + if verbose: + print("no .git in %%s" %% root) + return {} + + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + stdout = run_command(GITS, ["describe", "--tags", "--dirty", "--always"], + cwd=root) + if stdout is None: + return {} + if not stdout.startswith(tag_prefix): + if verbose: + print("tag '%%s' doesn't start with prefix '%%s'" %% (stdout, tag_prefix)) + return {} + tag = stdout[len(tag_prefix):] + stdout = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if stdout is None: + return {} + full = stdout.strip() + if tag.endswith("-dirty"): + full += "-dirty" + return {"version": tag, "full": full} + + +def versions_from_parentdir(parentdir_prefix, root, verbose=False): + # Source tarballs conventionally unpack into a directory that includes + # both the project name and a version string. + dirname = os.path.basename(root) + if not dirname.startswith(parentdir_prefix): + if verbose: + print("guessing rootdir is '%%s', but '%%s' doesn't start with prefix '%%s'" %% + (root, dirname, parentdir_prefix)) + return None + return {"version": dirname[len(parentdir_prefix):], "full": ""} + +tag_prefix = "%(TAG_PREFIX)s" +parentdir_prefix = "%(PARENTDIR_PREFIX)s" +versionfile_source = "%(VERSIONFILE_SOURCE)s" + +def get_versions(default={"version": "unknown", "full": ""}, verbose=False): + # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have + # __file__, we can work backwards from there to the root. Some + # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which + # case we can only use expanded variables. + + variables = { "refnames": git_refnames, "full": git_full } + ver = versions_from_expanded_variables(variables, tag_prefix, verbose) + if ver: + return ver + + try: + root = os.path.abspath(__file__) + # versionfile_source is the relative path from the top of the source + # tree (where the .git directory might live) to this file. Invert + # this to find the root from __file__. + for i in range(len(versionfile_source.split("/"))): + root = os.path.dirname(root) + except NameError: + return default + + return (versions_from_vcs(tag_prefix, root, verbose) + or versions_from_parentdir(parentdir_prefix, root, verbose) + or default) + +''' + + +import subprocess +import sys +import errno + + +def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False): + assert isinstance(commands, list) + p = None + for c in commands: + try: + # remember shell=False, so use git.cmd on windows, not just git + p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE, + stderr=(subprocess.PIPE if hide_stderr + else None)) + break + except EnvironmentError: + e = sys.exc_info()[1] + if e.errno == errno.ENOENT: + continue + if verbose: + print("unable to run %s" % args[0]) + print(e) + return None + else: + if verbose: + print("unable to find command, tried %s" % (commands,)) + return None + stdout = p.communicate()[0].strip() + if sys.version >= '3': + stdout = stdout.decode() + if p.returncode != 0: + if verbose: + print("unable to run %s (error)" % args[0]) + return None + return stdout + + +import sys +import re +import os.path + +def get_expanded_variables(versionfile_abs): + # the code embedded in _version.py can just fetch the value of these + # variables. When used from setup.py, we don't want to import + # _version.py, so we do it with a regexp instead. This function is not + # used from _version.py. + variables = {} + try: + f = open(versionfile_abs,"r") + for line in f.readlines(): + if line.strip().startswith("git_refnames ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["refnames"] = mo.group(1) + if line.strip().startswith("git_full ="): + mo = re.search(r'=\s*"(.*)"', line) + if mo: + variables["full"] = mo.group(1) + f.close() + except EnvironmentError: + pass + return variables + +def versions_from_expanded_variables(variables, tag_prefix, verbose=False): + refnames = variables["refnames"].strip() + if refnames.startswith("$Format"): + if verbose: + print("variables are unexpanded, not using") + return {} # unexpanded, so not in an unpacked git-archive tarball + refs = set([r.strip() for r in refnames.strip("()").split(",")]) + # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of + # just "foo-1.0". If we see a "tag: " prefix, prefer those. + TAG = "tag: " + tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) + if not tags: + # Either we're using git < 1.8.3, or there really are no tags. We use + # a heuristic: assume all version tags have a digit. The old git %d + # expansion behaves like git log --decorate=short and strips out the + # refs/heads/ and refs/tags/ prefixes that would let us distinguish + # between branches and tags. By ignoring refnames without digits, we + # filter out many common branch names like "release" and + # "stabilization", as well as "HEAD" and "master". + tags = set([r for r in refs if re.search(r'\d', r)]) + if verbose: + print("discarding '%s', no digits" % ",".join(refs-tags)) + if verbose: + print("likely tags: %s" % ",".join(sorted(tags))) + for ref in sorted(tags): + # sorting will prefer e.g. "2.0" over "2.0rc1" + if ref.startswith(tag_prefix): + r = ref[len(tag_prefix):] + if verbose: + print("picking %s" % r) + return { "version": r, + "full": variables["full"].strip() } + # no suitable tags, so we use the full revision id + if verbose: + print("no suitable tags, using full revision id") + return { "version": variables["full"].strip(), + "full": variables["full"].strip() } + +def versions_from_vcs(tag_prefix, root, verbose=False): + # this runs 'git' from the root of the source tree. This only gets called + # if the git-archive 'subst' variables were *not* expanded, and + # _version.py hasn't already been rewritten with a short version string, + # meaning we're inside a checked out source tree. + + if not os.path.exists(os.path.join(root, ".git")): + if verbose: + print("no .git in %s" % root) + return {} + + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + stdout = run_command(GITS, ["describe", "--tags", "--dirty", "--always"], + cwd=root) + if stdout is None: + return {} + if not stdout.startswith(tag_prefix): + if verbose: + print("tag '%s' doesn't start with prefix '%s'" % (stdout, tag_prefix)) + return {} + tag = stdout[len(tag_prefix):] + stdout = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) + if stdout is None: + return {} + full = stdout.strip() + if tag.endswith("-dirty"): + full += "-dirty" + return {"version": tag, "full": full} + + +def versions_from_parentdir(parentdir_prefix, root, verbose=False): + # Source tarballs conventionally unpack into a directory that includes + # both the project name and a version string. + dirname = os.path.basename(root) + if not dirname.startswith(parentdir_prefix): + if verbose: + print("guessing rootdir is '%s', but '%s' doesn't start with prefix '%s'" % + (root, dirname, parentdir_prefix)) + return None + return {"version": dirname[len(parentdir_prefix):], "full": ""} +import os.path +import sys + +# os.path.relpath only appeared in Python-2.6 . Define it here for 2.5. +def os_path_relpath(path, start=os.path.curdir): + """Return a relative version of a path""" + + if not path: + raise ValueError("no path specified") + + start_list = [x for x in os.path.abspath(start).split(os.path.sep) if x] + path_list = [x for x in os.path.abspath(path).split(os.path.sep) if x] + + # Work out how much of the filepath is shared by start and path. + i = len(os.path.commonprefix([start_list, path_list])) + + rel_list = [os.path.pardir] * (len(start_list)-i) + path_list[i:] + if not rel_list: + return os.path.curdir + return os.path.join(*rel_list) + +def do_vcs_install(manifest_in, versionfile_source, ipy): + GITS = ["git"] + if sys.platform == "win32": + GITS = ["git.cmd", "git.exe"] + files = [manifest_in, versionfile_source, ipy] + try: + me = __file__ + if me.endswith(".pyc") or me.endswith(".pyo"): + me = os.path.splitext(me)[0] + ".py" + versioneer_file = os_path_relpath(me) + except NameError: + versioneer_file = "versioneer.py" + files.append(versioneer_file) + present = False + try: + f = open(".gitattributes", "r") + for line in f.readlines(): + if line.strip().startswith(versionfile_source): + if "export-subst" in line.strip().split()[1:]: + present = True + f.close() + except EnvironmentError: + pass + if not present: + f = open(".gitattributes", "a+") + f.write("%s export-subst\n" % versionfile_source) + f.close() + files.append(".gitattributes") + run_command(GITS, ["add", "--"] + files) + +SHORT_VERSION_PY = """ +# This file was generated by 'versioneer.py' (0.10) from +# revision-control system data, or from the parent directory name of an +# unpacked source archive. Distribution tarballs contain a pre-generated copy +# of this file. + +version_version = '%(version)s' +version_full = '%(full)s' +def get_versions(default={}, verbose=False): + return {'version': version_version, 'full': version_full} + +""" + +DEFAULT = {"version": "unknown", "full": "unknown"} + +def versions_from_file(filename): + versions = {} + try: + f = open(filename) + except EnvironmentError: + return versions + for line in f.readlines(): + mo = re.match("version_version = '([^']+)'", line) + if mo: + versions["version"] = mo.group(1) + mo = re.match("version_full = '([^']+)'", line) + if mo: + versions["full"] = mo.group(1) + f.close() + return versions + +def write_to_version_file(filename, versions): + f = open(filename, "w") + f.write(SHORT_VERSION_PY % versions) + f.close() + print("set %s to '%s'" % (filename, versions["version"])) + +def get_root(): + try: + return os.path.dirname(os.path.abspath(__file__)) + except NameError: + return os.path.dirname(os.path.abspath(sys.argv[0])) + +def get_versions(default=DEFAULT, verbose=False): + # returns dict with two keys: 'version' and 'full' + assert versionfile_source is not None, "please set versioneer.versionfile_source" + assert tag_prefix is not None, "please set versioneer.tag_prefix" + assert parentdir_prefix is not None, "please set versioneer.parentdir_prefix" + # I am in versioneer.py, which must live at the top of the source tree, + # which we use to compute the root directory. py2exe/bbfreeze/non-CPython + # don't have __file__, in which case we fall back to sys.argv[0] (which + # ought to be the setup.py script). We prefer __file__ since that's more + # robust in cases where setup.py was invoked in some weird way (e.g. pip) + root = get_root() + versionfile_abs = os.path.join(root, versionfile_source) + + # extract version from first of _version.py, 'git describe', parentdir. + # This is meant to work for developers using a source checkout, for users + # of a tarball created by 'setup.py sdist', and for users of a + # tarball/zipball created by 'git archive' or github's download-from-tag + # feature. + + variables = get_expanded_variables(versionfile_abs) + if variables: + ver = versions_from_expanded_variables(variables, tag_prefix) + if ver: + if verbose: print("got version from expanded variable %s" % ver) + return ver + + ver = versions_from_file(versionfile_abs) + if ver: + if verbose: print("got version from file %s %s" % (versionfile_abs,ver)) + return ver + + ver = versions_from_vcs(tag_prefix, root, verbose) + if ver: + if verbose: print("got version from git %s" % ver) + return ver + + ver = versions_from_parentdir(parentdir_prefix, root, verbose) + if ver: + if verbose: print("got version from parentdir %s" % ver) + return ver + + if verbose: print("got version from default %s" % ver) + return default + +def get_version(verbose=False): + return get_versions(verbose=verbose)["version"] + +class cmd_version(Command): + description = "report generated version string" + user_options = [] + boolean_options = [] + def initialize_options(self): + pass + def finalize_options(self): + pass + def run(self): + ver = get_version(verbose=True) + print("Version is currently: %s" % ver) + +class cmd_build_py(_build_py): + def run(self): + versions = get_versions(verbose=True) + _build_py.run(self) + # now locate _version.py in the new build/ directory and replace it + # with an updated value + target_versionfile = os.path.join(self.build_lib, versionfile_build) + print("UPDATING %s" % target_versionfile) + os.unlink(target_versionfile) + f = open(target_versionfile, "w") + f.write(SHORT_VERSION_PY % versions) + f.close() + +class cmd_build(_build): + def run(self): + versions = get_versions(verbose=True) + _build.run(self) + # now locate _version.py in the new build/ directory and replace it + # with an updated value + target_versionfile = os.path.join(self.build_lib, versionfile_build) + print("UPDATING %s" % target_versionfile) + os.unlink(target_versionfile) + f = open(target_versionfile, "w") + f.write(SHORT_VERSION_PY % versions) + f.close() + +if 'cx_Freeze' in sys.modules: # cx_freeze enabled? + from cx_Freeze.dist import build_exe as _build_exe + + class cmd_build_exe(_build_exe): + def run(self): + versions = get_versions(verbose=True) + target_versionfile = versionfile_source + print("UPDATING %s" % target_versionfile) + os.unlink(target_versionfile) + f = open(target_versionfile, "w") + f.write(SHORT_VERSION_PY % versions) + f.close() + _build_exe.run(self) + os.unlink(target_versionfile) + f = open(versionfile_source, "w") + f.write(LONG_VERSION_PY % {"DOLLAR": "$", + "TAG_PREFIX": tag_prefix, + "PARENTDIR_PREFIX": parentdir_prefix, + "VERSIONFILE_SOURCE": versionfile_source, + }) + f.close() + +class cmd_sdist(_sdist): + def run(self): + versions = get_versions(verbose=True) + self._versioneer_generated_versions = versions + # unless we update this, the command will keep using the old version + self.distribution.metadata.version = versions["version"] + return _sdist.run(self) + + def make_release_tree(self, base_dir, files): + _sdist.make_release_tree(self, base_dir, files) + # now locate _version.py in the new base_dir directory (remembering + # that it may be a hardlink) and replace it with an updated value + target_versionfile = os.path.join(base_dir, versionfile_source) + print("UPDATING %s" % target_versionfile) + os.unlink(target_versionfile) + f = open(target_versionfile, "w") + f.write(SHORT_VERSION_PY % self._versioneer_generated_versions) + f.close() + +INIT_PY_SNIPPET = """ +from ._version import get_versions +__version__ = get_versions()['version'] +del get_versions +""" + +class cmd_update_files(Command): + description = "install/upgrade Versioneer files: __init__.py SRC/_version.py" + user_options = [] + boolean_options = [] + def initialize_options(self): + pass + def finalize_options(self): + pass + def run(self): + print(" creating %s" % versionfile_source) + f = open(versionfile_source, "w") + f.write(LONG_VERSION_PY % {"DOLLAR": "$", + "TAG_PREFIX": tag_prefix, + "PARENTDIR_PREFIX": parentdir_prefix, + "VERSIONFILE_SOURCE": versionfile_source, + }) + f.close() + + ipy = os.path.join(os.path.dirname(versionfile_source), "__init__.py") + try: + old = open(ipy, "r").read() + except EnvironmentError: + old = "" + if INIT_PY_SNIPPET not in old: + print(" appending to %s" % ipy) + f = open(ipy, "a") + f.write(INIT_PY_SNIPPET) + f.close() + else: + print(" %s unmodified" % ipy) + + # Make sure both the top-level "versioneer.py" and versionfile_source + # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so + # they'll be copied into source distributions. Pip won't be able to + # install the package without this. + manifest_in = os.path.join(get_root(), "MANIFEST.in") + simple_includes = set() + try: + for line in open(manifest_in, "r").readlines(): + if line.startswith("include "): + for include in line.split()[1:]: + simple_includes.add(include) + except EnvironmentError: + pass + # That doesn't cover everything MANIFEST.in can do + # (http://docs.python.org/2/distutils/sourcedist.html#commands), so + # it might give some false negatives. Appending redundant 'include' + # lines is safe, though. + if "versioneer.py" not in simple_includes: + print(" appending 'versioneer.py' to MANIFEST.in") + f = open(manifest_in, "a") + f.write("include versioneer.py\n") + f.close() + else: + print(" 'versioneer.py' already in MANIFEST.in") + if versionfile_source not in simple_includes: + print(" appending versionfile_source ('%s') to MANIFEST.in" % + versionfile_source) + f = open(manifest_in, "a") + f.write("include %s\n" % versionfile_source) + f.close() + else: + print(" versionfile_source already in MANIFEST.in") + + # Make VCS-specific changes. For git, this means creating/changing + # .gitattributes to mark _version.py for export-time keyword + # substitution. + do_vcs_install(manifest_in, versionfile_source, ipy) + +def get_cmdclass(): + cmds = {'version': cmd_version, + 'versioneer': cmd_update_files, + 'build': cmd_build, + 'build_py': cmd_build_py, + 'sdist': cmd_sdist, + } + if 'cx_Freeze' in sys.modules: # cx_freeze enabled? + cmds['build_exe'] = cmd_build_exe + del cmds['build'] + + return cmds From 603f667f934095a66e8f1e4c40f6b7553bd2f6ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Sun, 22 Jun 2014 01:15:31 +0200 Subject: [PATCH 04/24] Removed left overs from old VERSION tracking --- VERSION | 1 - setup.py | 3 --- 2 files changed, 4 deletions(-) delete mode 100644 VERSION diff --git a/VERSION b/VERSION deleted file mode 100644 index 8376431e..00000000 --- a/VERSION +++ /dev/null @@ -1 +0,0 @@ -1.1.0-rc1 diff --git a/setup.py b/setup.py index 1dc91f38..28aa334c 100644 --- a/setup.py +++ b/setup.py @@ -10,11 +10,8 @@ versioneer.parentdir_prefix = 'octoprint-' from setuptools import setup, find_packages -VERSION = open("VERSION").read().strip() - def params(): name = "OctoPrint" - version = VERSION description = "A responsive web interface for 3D printers" long_description = open("README.md").read() classifiers = [ From 772ebd198a8f590abb4f69778ba728e37a300f58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Mon, 23 Jun 2014 10:35:59 +0200 Subject: [PATCH 05/24] Fixed setup.py to correctly work with versioneer (cherry picked from commit de7808d) --- setup.py | 21 +++++++++++++++++---- versioneer.py | 12 ++++++++---- 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/setup.py b/setup.py index 28aa334c..21bed682 100644 --- a/setup.py +++ b/setup.py @@ -6,12 +6,27 @@ versioneer.VCS = 'git' versioneer.versionfile_source = 'src/octoprint/_version.py' versioneer.versionfile_build = 'octoprint/_version.py' versioneer.tag_prefix = '' -versioneer.parentdir_prefix = 'octoprint-' +versioneer.parentdir_prefix = '' from setuptools import setup, find_packages +import os + +def package_data_dirs(source, sub_folders): + dirs = [] + + for d in sub_folders: + for dirname, _, files in os.walk(os.path.join(source, d)): + dirname = os.path.relpath(dirname, source) + for f in files: + dirs.append(os.path.join(dirname, f)) + + return dirs def params(): name = "OctoPrint" + version = versioneer.get_version() + cmdclass = versioneer.get_cmdclass() + description = "A responsive web interface for 3D printers" long_description = open("README.md").read() classifiers = [ @@ -40,6 +55,7 @@ def params(): packages = find_packages(where="src") package_dir = {"octoprint": "src/octoprint"} + package_data = {"octoprint": package_data_dirs('src/octoprint', ['static', 'templates'])} include_package_data = True zip_safe = False @@ -55,9 +71,6 @@ def params(): # "scripts/octoprint.init": "/etc/init.d/octoprint" #} - version = versioneer.get_version() - cmdclass = versioneer.get_cmdclass() - return locals() setup(**params()) diff --git a/versioneer.py b/versioneer.py index b7e37ae2..a01ab1ce 100644 --- a/versioneer.py +++ b/versioneer.py @@ -745,26 +745,30 @@ class cmd_version(Command): class cmd_build_py(_build_py): def run(self): - versions = get_versions(verbose=True) _build_py.run(self) + + versions = get_versions(verbose=True) # now locate _version.py in the new build/ directory and replace it # with an updated value target_versionfile = os.path.join(self.build_lib, versionfile_build) print("UPDATING %s" % target_versionfile) - os.unlink(target_versionfile) + if os.path.exists(target_versionfile): + os.unlink(target_versionfile) f = open(target_versionfile, "w") f.write(SHORT_VERSION_PY % versions) f.close() class cmd_build(_build): def run(self): - versions = get_versions(verbose=True) _build.run(self) + + versions = get_versions(verbose=True) # now locate _version.py in the new build/ directory and replace it # with an updated value target_versionfile = os.path.join(self.build_lib, versionfile_build) print("UPDATING %s" % target_versionfile) - os.unlink(target_versionfile) + if os.path.exists(target_versionfile): + os.unlink(target_versionfile) f = open(target_versionfile, "w") f.write(SHORT_VERSION_PY % versions) f.close() From 32a38af4f76c951d5f082faa5a77e734cb1fcb22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Sun, 27 Jul 2014 16:18:30 +0200 Subject: [PATCH 06/24] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99bafba2..b762644f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,11 @@ -Bug Reports ------------ +Issues, Tickets, however you may call them +------------------------------------------ -**READ [How to file a bug report](https://github.com/foosel/OctoPrint/wiki/How-to-file-a-bug-report)!**. +- If you want to report a bug, **READ [How to file a bug report](https://github.com/foosel/OctoPrint/wiki/How-to-file-a-bug-report)!** Tickets will be automatically checked if they comply with the requirements outlined in that wiki node! +- If you want to post a **request** of any kind (feature request, documentation request, ...), **add [Request] to your issue's title!** +- If you need **support** with a problem of your installation, **add [Support] to your issue's title!** +- If you have a general **question**, **add [Question] to your issue's title!** +- If you have another reason for creating a ticket that doesn't fit any of the above categories, **add [Misc] to your issue's title!** Pull Requests ------------- From 48dc27e1060393b0b4e98f25358711d73bf2b7f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Fri, 1 Aug 2014 14:23:11 +0200 Subject: [PATCH 07/24] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b762644f..b31b719b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ Issues, Tickets, however you may call them ------------------------------------------ -- If you want to report a bug, **READ [How to file a bug report](https://github.com/foosel/OctoPrint/wiki/How-to-file-a-bug-report)!** Tickets will be automatically checked if they comply with the requirements outlined in that wiki node! +- If you want to report a bug, **READ [How to file a bug report](https://github.com/foosel/OctoPrint/wiki/How-to-file-a-bug-report)!** Tickets will be automatically checked if they comply with the requirements outlined in that wiki node! Other then what's written in there you don't have to do anything special with your ticket. - If you want to post a **request** of any kind (feature request, documentation request, ...), **add [Request] to your issue's title!** -- If you need **support** with a problem of your installation, **add [Support] to your issue's title!** +- If you need **support** with a problem of your installation (e.g. if you have problems getting the webcam to work), **add [Support] to your issue's title!** - If you have a general **question**, **add [Question] to your issue's title!** - If you have another reason for creating a ticket that doesn't fit any of the above categories, **add [Misc] to your issue's title!** From c552e9e9bea7f3c7bf3024e496d5e8de20fbb8a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Fri, 8 Aug 2014 16:22:48 +0200 Subject: [PATCH 08/24] Fixed a couple of issue with the gcode viewer Most notably the interfering options tracked in #398, but also made "Center viewport on model" and "Zoom in on model" automatically deselect and de-apply if viewport gets manipulated by user, therefore properly allowing the re-select by the user to work to. Closes #398 (cherry picked from commit f195af0) --- .../static/gcodeviewer/js/renderer.js | 117 ++++++++++++++---- .../static/js/app/viewmodels/gcode.js | 20 ++- 2 files changed, 112 insertions(+), 25 deletions(-) diff --git a/src/octoprint/static/gcodeviewer/js/renderer.js b/src/octoprint/static/gcodeviewer/js/renderer.js index c0f28688..3c7d2ee7 100644 --- a/src/octoprint/static/gcodeviewer/js/renderer.js +++ b/src/octoprint/static/gcodeviewer/js/renderer.js @@ -46,7 +46,9 @@ GCODE.renderer = (function(){ centerViewport: false, bed: {x: 200, y: 200}, - container: undefined + container: undefined, + + onInternalOptionChange: undefined }; var offsetModelX = 0, offsetModelY = 0; @@ -140,45 +142,107 @@ GCODE.renderer = (function(){ ctx.lineCap = 'round'; trackTransforms(ctx); - canvas.addEventListener('mousedown',function(evt){ + // dragging => translating + canvas.addEventListener('mousedown', function(event){ document.body.style.mozUserSelect = document.body.style.webkitUserSelect = document.body.style.userSelect = 'none'; - lastX = evt.offsetX || (evt.pageX - canvas.offsetLeft); - lastY = evt.offsetY || (evt.pageY - canvas.offsetTop); - dragStart = ctx.transformedPoint(lastX,lastY); + + // remember starting point of dragging gesture + lastX = event.offsetX || (event.pageX - canvas.offsetLeft); + lastY = event.offsetY || (event.pageY - canvas.offsetTop); + dragStart = ctx.transformedPoint(lastX, lastY); + + // not yet dragged anything dragged = false; - },false); - canvas.addEventListener('mousemove',function(evt){ - lastX = evt.offsetX || (evt.pageX - canvas.offsetLeft); - lastY = evt.offsetY || (evt.pageY - canvas.offsetTop); + }, false); + + canvas.addEventListener('mousemove', function(event){ + // save current mouse coordinates + lastX = event.offsetX || (event.pageX - canvas.offsetLeft); + lastY = event.offsetY || (event.pageY - canvas.offsetTop); + + // mouse movement => dragged dragged = true; - if (dragStart){ + + if (dragStart !== undefined){ + // translate var pt = ctx.transformedPoint(lastX,lastY); - ctx.translate(pt.x-dragStart.x,pt.y-dragStart.y); + ctx.translate(pt.x - dragStart.x, pt.y - dragStart.y); reRender(); + + renderOptions["centerViewport"] = false; + renderOptions["zoomInOnModel"] = false; + renderOptions["zoomInOnBed"] = false; + offsetModelX = 0; + offsetModelY = 0; + offsetBedX = 0; + offsetBedY = 0; + scaleX = 1; + scaleY = 1; + + if (renderOptions["onInternalOptionChange"] !== undefined) { + renderOptions["onInternalOptionChange"]({ + centerViewport: false, + moveModel: false, + zoomInOnModel: false, + zoomInOnBed: false + }); + } } - },false); - canvas.addEventListener('mouseup',function(evt){ - dragStart = null; - if (!dragged) zoom(evt.shiftKey ? -1 : 1 ); - },false); + }, false); + + canvas.addEventListener('mouseup', function(event){ + // reset dragStart + dragStart = undefined; + }, false); + + // mouse wheel => zooming var zoom = function(clicks){ - var pt = ctx.transformedPoint(lastX,lastY); + // focus on last mouse position prior to zoom + var pt = ctx.transformedPoint(lastX, lastY); ctx.translate(pt.x,pt.y); + + // determine zooming factor and perform zoom var factor = Math.pow(scaleFactor,clicks); ctx.scale(factor,factor); + + // return to old position ctx.translate(-pt.x,-pt.y); + + // render reRender(); + + // disable conflicting options + renderOptions["zoomInOnModel"] = false; + renderOptions["zoomInOnBed"] = false; + offsetModelX = 0; + offsetModelY = 0; + offsetBedX = 0; + offsetBedY = 0; + scaleX = 1; + scaleY = 1; + + if (renderOptions["onInternalOptionChange"] !== undefined) { + renderOptions["onInternalOptionChange"]({ + zoomInOnModel: false, + zoomInOnBed: false + }); + } }; - var handleScroll = function(evt){ + var handleScroll = function(event){ var delta; - if(evt.detail<0 || evt.wheelDelta>0)delta=zoomFactorDelta; - else delta=-1*zoomFactorDelta; + + // determine zoom direction & delta + if (event.detail < 0 || event.wheelDelta > 0) { + delta = zoomFactorDelta; + } else { + delta = -1 * zoomFactorDelta; + } if (delta) zoom(delta); - return evt.preventDefault() && false; + + return event.preventDefault() && false; }; canvas.addEventListener('DOMMouseScroll',handleScroll,false); canvas.addEventListener('mousewheel',handleScroll,false); - }; var drawGrid = function() { @@ -368,8 +432,13 @@ GCODE.renderer = (function(){ }; var applyZoom = function(mdlInfo) { + // get middle of canvas var pt = ctx.transformedPoint(canvas.width/2,canvas.height/2); + + // get current transform var transform = ctx.getTransform(); + + // move to middle of canvas, reset scale, move back if (scaleX && scaleY && transform.a && transform.d) { ctx.translate(pt.x, pt.y); ctx.scale(1 / scaleX, 1 / scaleY); @@ -378,6 +447,7 @@ GCODE.renderer = (function(){ } if (mdlInfo && renderOptions["zoomInOnModel"]) { + // if we need to zoom in on model, scale factor is calculated by longer side of object in relation to that axis of canvas var scaleF = mdlInfo.modelSize.x > mdlInfo.modelSize.y ? (canvas.width - 10) / mdlInfo.modelSize.x : (canvas.height - 10) / mdlInfo.modelSize.y; scaleF /= zoomFactor; if (transform.a && transform.d) { @@ -388,6 +458,7 @@ GCODE.renderer = (function(){ ctx.translate(-pt.x, -pt.y); } } else { + // reset scale to 1 scaleX = 1; scaleY = 1; } @@ -416,7 +487,7 @@ GCODE.renderer = (function(){ dirty = true; renderOptions[opt] = options[opt]; - if ($.inArray(opt, ["moveModel", "centerViewport", "zoomInOnModel", "bed"])) { + if ($.inArray(opt, ["moveModel", "centerViewport", "zoomInOnModel", "bed"]) > -1) { mustRefresh = true; } } diff --git a/src/octoprint/static/js/app/viewmodels/gcode.js b/src/octoprint/static/js/app/viewmodels/gcode.js index efba29c0..5b5f9b33 100644 --- a/src/octoprint/static/js/app/viewmodels/gcode.js +++ b/src/octoprint/static/js/app/viewmodels/gcode.js @@ -60,7 +60,8 @@ function GcodeViewModel(loginStateViewModel, settingsViewModel) { extrusionWidth: self.renderer_extrusionWidthEnabled() ? self.renderer_extrusionWidth() : 1, showNextLayer: self.renderer_showNext(), showPreviousLayer: self.renderer_showPrevious(), - zoomInOnModel: self.renderer_zoomOnModel() + zoomInOnModel: self.renderer_zoomOnModel(), + onInternalOptionChange: self._onInternalRendererOptionChange }; if (additionalRendererOptions) { _.extend(renderer, additionalRendererOptions); @@ -155,7 +156,7 @@ function GcodeViewModel(loginStateViewModel, settingsViewModel) { self.clear = function() { GCODE.ui.clear(); - } + }; self._configureLayerSlider = function() { self.layerSlider = $("#gcode_slider_layers").slider({ @@ -353,6 +354,20 @@ function GcodeViewModel(loginStateViewModel, settingsViewModel) { } }; + self._onInternalRendererOptionChange = function(options) { + if (!options) return; + + for (var opt in options) { + if (opt == "zoomInOnModel" && options[opt] != self.renderer_zoomOnModel()) { + self.renderer_zoomOnModel(false); + } else if (opt == "centerViewport" && options[opt] != self.renderer_centerViewport()) { + self.renderer_centerViewport(false); + } else if (opt == "moveModel" && options[opt] != self.renderer_centerModel()) { + self.renderer_centerModel(false); + } + } + }; + self.changeLayer = function(event) { if (self.currentlyPrinting && self.renderer_syncProgress()) self.renderer_syncProgress(false); @@ -372,4 +387,5 @@ function GcodeViewModel(loginStateViewModel, settingsViewModel) { GCODE.ui.changeSelectedCommands(self.layerSlider.slider("getValue"), tuple[0], tuple[1]); }; + } From 7028bbfbfd2b3502b87448d1bbb6af6517dd1eb6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Wed, 14 May 2014 22:48:56 +0200 Subject: [PATCH 09/24] GCODE viewer now interprets inverted axes for printer control and mirrors print bed accordingly. Should enable people to set their axes origin so that the viewer matches what they see on their printer. Should close #431 (cherry picked from commit 030ffe6) --- .../static/gcodeviewer/js/renderer.js | 109 ++++++++++++------ src/octoprint/static/gcodeviewer/js/ui.js | 8 +- .../static/js/app/viewmodels/gcode.js | 35 ++++-- .../static/js/app/viewmodels/settings.js | 4 +- 4 files changed, 110 insertions(+), 46 deletions(-) diff --git a/src/octoprint/static/gcodeviewer/js/renderer.js b/src/octoprint/static/gcodeviewer/js/renderer.js index 3c7d2ee7..a1202006 100644 --- a/src/octoprint/static/gcodeviewer/js/renderer.js +++ b/src/octoprint/static/gcodeviewer/js/renderer.js @@ -44,6 +44,7 @@ GCODE.renderer = (function(){ zoomInOnModel: false, zoomInOnBed: false, centerViewport: false, + invertAxes: {x: false, y: false}, bed: {x: 200, y: 200}, container: undefined, @@ -56,6 +57,7 @@ GCODE.renderer = (function(){ var scaleX = 1, scaleY = 1; var speeds = []; var speedsByLayer = {}; + var currentInvertX = false, currentInvertY = false; var reRender = function(){ var p1 = ctx.transformedPoint(0,0); @@ -290,8 +292,11 @@ GCODE.renderer = (function(){ var i; - isNotCurrentLayer = typeof isNotCurrentLayer !== 'undefined' ? isNotCurrentLayer : false; + //~~ store current layer values + + isNotCurrentLayer = isNotCurrentLayer !== undefined ? isNotCurrentLayer : false; if (!isNotCurrentLayer) { + // not not current layer == current layer => store layer number and from/to progress layerNumStore = layerNum; progressStore = {from: fromProgress, to: toProgress}; } @@ -301,67 +306,74 @@ GCODE.renderer = (function(){ var cmds = model[layerNum]; var x, y; - if (fromProgress > 0) { - prevX = cmds[fromProgress-1].x * zoomFactor; - prevY = -cmds[fromProgress-1].y * zoomFactor; - } else if (fromProgress === 0 && layerNum == 0) { - if (model[0] && model[0].x !== undefined && model[0].y !== undefined) { - prevX = model[0].x * zoomFactor; - prevY = -model[0].y * zoomFactor; - } else { - prevX = 0; - prevY = 0; - } - } else if(typeof(cmds[0].prevX) !== 'undefined' && typeof(cmds[0].prevY) !== 'undefined') { + //~~ find our initial prevX/prevY tuple + + if (cmds[0].prevX !== undefined && cmds[0].prevY !== undefined) { + // command contains prevX/prevY values, use those prevX = cmds[0].prevX * zoomFactor; - prevY = -cmds[0].prevY * zoomFactor; - } else { - if (model[layerNum-1]) { - prevX = undefined; - prevY = undefined; - for (i = model[layerNum-1].length-1; i >= 0; i--) { - if (prevX === undefined && model[layerNum-1][i].x !== undefined) prevX = model[layerNum-1][i].x * zoomFactor; - if (prevY === undefined && model[layerNum-1][i].y !== undefined) prevY =- model[layerNum-1][i].y * zoomFactor; - } - if (prevX === undefined) prevX=0; - if (prevY === undefined) prevY=0; - } else { - prevX = 0; - prevY = 0; + prevY = -1 * cmds[0].prevY * zoomFactor; + } else if (fromProgress > 0) { + // previous command in same layer exists, use x/y as prevX/prevY + prevX = cmds[fromProgress - 1].x * zoomFactor; + prevY = -cmds[fromProgress - 1].y * zoomFactor; + } else if (model[layerNum - 1]) { + // previous layer exists, use last x/y as prevX/prevY + prevX = undefined; + prevY = undefined; + for (i = model[layerNum-1].length-1; i >= 0; i--) { + if (prevX === undefined && model[layerNum - 1][i].x !== undefined) prevX = model[layerNum - 1][i].x * zoomFactor; + if (prevY === undefined && model[layerNum - 1][i].y !== undefined) prevY =- model[layerNum - 1][i].y * zoomFactor; } } + // if we did not find prevX or prevY, set it to 0 (might be that we are on the first command of the first layer, + // or it's just a very weird model...) + if (prevX === undefined) prevX = 0; + if (prevY === undefined) prevY = 0; + + //~~ render this layer's commands + for (i = fromProgress; i <= toProgress; i++) { ctx.lineWidth = 1; if (typeof(cmds[i]) === 'undefined') continue; if (typeof(cmds[i].prevX) !== 'undefined' && typeof(cmds[i].prevY) !== 'undefined') { + // override new (prevX, prevY) prevX = cmds[i].prevX * zoomFactor; - prevY = -cmds[i].prevY * zoomFactor; + prevY = -1 * cmds[i].prevY * zoomFactor; } + // new x if (typeof(cmds[i].x) === 'undefined' || isNaN(cmds[i].x)) { x = prevX / zoomFactor; } else { x = cmds[i].x; } + + // new y if (typeof(cmds[i].y) === 'undefined' || isNaN(cmds[i].y)) { y = prevY / zoomFactor; } else { y = -cmds[i].y; } + // current tool var tool = cmds[i].tool; if (tool === undefined) tool = 0; + // line color based on tool var lineColor = renderOptions["colorLine"][tool]; if (lineColor === undefined) lineColor = renderOptions["colorLine"][0]; + // alpha value (100% if current layer is being rendered, 30% otherwise) var alpha = (renderOptions['showNextLayer'] || renderOptions['showPreviousLayer']) && isNotCurrentLayer ? 0.3 : 1.0; var shade = tool * 0.15; + if (!cmds[i].extrude && !cmds[i].noMove) { + // neither extrusion nor move if (cmds[i].retract == -1) { + // retract => draw dot if configured to do so if (renderOptions["showRetracts"]) { ctx.strokeStyle = pusher.color(renderOptions["colorRetract"]).shade(shade).alpha(alpha).html(); ctx.fillStyle = pusher.color(renderOptions["colorRetract"]).shade(shade).alpha(alpha).html(); @@ -371,7 +383,9 @@ GCODE.renderer = (function(){ ctx.fill(); } } + if(renderOptions["showMoves"]){ + // move => draw line from (prevX, prevY) to (x, y) in move color ctx.strokeStyle = pusher.color(renderOptions["colorMove"]).shade(shade).alpha(alpha).html(); ctx.beginPath(); ctx.moveTo(prevX, prevY); @@ -380,6 +394,7 @@ GCODE.renderer = (function(){ } } else if(cmds[i].extrude) { if (cmds[i].retract == 0) { + // no retraction => real extrusion move, use tool color to draw line ctx.strokeStyle = pusher.color(renderOptions["colorLine"][tool]).shade(shade).alpha(alpha).html(); ctx.lineWidth = renderOptions['extrusionWidth']; ctx.beginPath(); @@ -387,6 +402,7 @@ GCODE.renderer = (function(){ ctx.lineTo(x*zoomFactor,y*zoomFactor); ctx.stroke(); } else { + // we were previously retracting, now we are restarting => draw dot if configured to do so if (renderOptions["showRetracts"]) { ctx.strokeStyle = pusher.color(renderOptions["colorRestart"]).shade(shade).alpha(alpha).html(); ctx.fillStyle = pusher.color(renderOptions["colorRestart"]).shade(shade).alpha(alpha).html(); @@ -397,6 +413,8 @@ GCODE.renderer = (function(){ } } } + + // set new (prevX, prevY) prevX = x * zoomFactor; prevY = y * zoomFactor; } @@ -451,8 +469,8 @@ GCODE.renderer = (function(){ var scaleF = mdlInfo.modelSize.x > mdlInfo.modelSize.y ? (canvas.width - 10) / mdlInfo.modelSize.x : (canvas.height - 10) / mdlInfo.modelSize.y; scaleF /= zoomFactor; if (transform.a && transform.d) { - scaleX = scaleF / transform.a; - scaleY = scaleF / transform.d; + scaleX = scaleF / transform.a * (renderOptions["invertAxes"]["x"] ? -1 : 1); + scaleY = scaleF / transform.d * (renderOptions["invertAxes"]["y"] ? -1 : 1); ctx.translate(pt.x,pt.y); ctx.scale(scaleX, scaleY); ctx.translate(-pt.x, -pt.y); @@ -464,13 +482,37 @@ GCODE.renderer = (function(){ } }; + var applyInversion = function() { + var width = canvas.width - 10; + var height = canvas.height - 10; + + if (currentInvertX || currentInvertY) { + ctx.scale(currentInvertX ? -1 : 1, currentInvertY ? -1 : 1); + ctx.translate(currentInvertX ? -width : 0, currentInvertY ? height : 0); + } + + var invertX = renderOptions["invertAxes"]["x"]; + var invertY = renderOptions["invertAxes"]["y"]; + if (invertX || invertY) { + ctx.translate(invertX ? width : 0, invertY ? -height : 0); + ctx.scale(invertX ? -1 : 1, invertY ? -1 : 1); + } + + currentInvertX = invertX; + currentInvertY = invertY; + }; + // ***** PUBLIC ******* return { init: function(){ startCanvas(); initialized = true; - zoomFactor = Math.min((canvas.width - 10) / renderOptions["bed"]["x"], (canvas.height - 10) / renderOptions["bed"]["y"]); - ctx.translate((canvas.width - renderOptions["bed"]["x"] * zoomFactor) / 2, renderOptions["bed"]["y"] * zoomFactor + (canvas.height - renderOptions["bed"]["y"] * zoomFactor) / 2); + var bedWidth = renderOptions["bed"]["x"]; + var bedHeight = renderOptions["bed"]["y"]; + if(renderOptions["bed"]["circular"]) { + bedWidth = bedHeight = renderOptions["bed"]["r"] * 2; + } + zoomFactor = Math.min((canvas.width - 10) / bedWidth, (canvas.height - 10) / bedHeight); offsetModelX = 0; offsetModelY = 0; @@ -487,7 +529,7 @@ GCODE.renderer = (function(){ dirty = true; renderOptions[opt] = options[opt]; - if ($.inArray(opt, ["moveModel", "centerViewport", "zoomInOnModel", "bed"]) > -1) { + if ($.inArray(opt, ["moveModel", "centerViewport", "zoomInOnModel", "bed", "invertAxes"]) > -1) { mustRefresh = true; } } @@ -568,6 +610,7 @@ GCODE.renderer = (function(){ } } + applyInversion(); applyOffsets(mdlInfo); applyZoom(mdlInfo); diff --git a/src/octoprint/static/gcodeviewer/js/ui.js b/src/octoprint/static/gcodeviewer/js/ui.js index 8f5a42fb..47d539fd 100644 --- a/src/octoprint/static/gcodeviewer/js/ui.js +++ b/src/octoprint/static/gcodeviewer/js/ui.js @@ -180,8 +180,12 @@ GCODE.ui = (function(){ updateOptions: function(options) { setOptions(options.ui); - GCODE.gCodeReader.setOption(options.reader); - GCODE.renderer.setOption(options.renderer); + if (options.reader) { + GCODE.gCodeReader.setOption(options.reader); + } + if (options.renderer) { + GCODE.renderer.setOption(options.renderer); + } }, changeSelectedLayer: function(newLayerNum) { diff --git a/src/octoprint/static/js/app/viewmodels/gcode.js b/src/octoprint/static/js/app/viewmodels/gcode.js index 5b5f9b33..2d3dc276 100644 --- a/src/octoprint/static/js/app/viewmodels/gcode.js +++ b/src/octoprint/static/js/app/viewmodels/gcode.js @@ -97,21 +97,38 @@ function GcodeViewModel(loginStateViewModel, settingsViewModel) { // subscribe to relevant printer settings... self.settings.printer_extruderOffsets.subscribe(function() { if (!self.enabled) return; + if (!self.settings.printer_extruderOffsets()) return; - var options = { + GCODE.ui.updateOptions({ reader: { toolOffsets: self.settings.printer_extruderOffsets() } - }; + }); + }); + self.settings.printer_bedDimensions.subscribe(function() { + if (!self.enabled) return; var bedDimensions = self.settings.printer_bedDimensions(); - if (bedDimensions && bedDimensions.hasOwnProperty("x") && bedDimensions.hasOwnProperty("y")) { - options["renderer"] = { - bed: self.settings.printer_bedDimensions() - } - } + if (!bedDimensions || (!bedDimensions.hasOwnProperty("x") && !bedDimensions.hasOwnProperty("y") && !bedDimensions.hasOwnProperty("r"))) return; - GCODE.ui.updateOptions(options); + GCODE.ui.updateOptions({ + renderer: { + bed: bedDimensions + } + }); + }); + self.settings.printer_invertAxes.subscribe(function() { + if (!self.enabled) return; + if (!self.settings.printer_invertAxes()) return; + + GCODE.ui.updateOptions({ + renderer: { + invertAxes: { + x: self.settings.printer_invertX(), + y: self.settings.printer_invertY() + } + } + }); }); self.loadedFilename = undefined; @@ -289,7 +306,7 @@ function GcodeViewModel(loginStateViewModel, settingsViewModel) { self.approveLargeFile = function() { self.waitForApproval(false); self.loadFile(self.selectedFile.name(), self.selectedFile.date()); - } + }; self._onProgress = function(type, percentage) { self.ui_progress_type(type); diff --git a/src/octoprint/static/js/app/viewmodels/settings.js b/src/octoprint/static/js/app/viewmodels/settings.js index 1647d2b8..177d7b53 100644 --- a/src/octoprint/static/js/app/viewmodels/settings.js +++ b/src/octoprint/static/js/app/viewmodels/settings.js @@ -177,7 +177,7 @@ function SettingsViewModel(loginStateViewModel, usersViewModel) { if (callback) callback(); } }); - } + }; self.fromResponse = function(response) { self.api_enabled(response.api.enabled); @@ -238,7 +238,7 @@ function SettingsViewModel(loginStateViewModel, usersViewModel) { self.system_actions(response.system.actions); self.terminalFilters(response.terminalFilters); - } + }; self.saveData = function() { var data = { From 568fcbf54799d29ad05ac74b072e270aebd95372 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Thu, 7 Aug 2014 18:07:19 +0200 Subject: [PATCH 10/24] Don't close serial port before switching to state "closed serial port" Depending on what was happening in the monitoring thread this could lead to an attempt to write to the already closed port, logging an error and killing the interface in the process. Also fixed a timing issue in the state reporting towards the frontend, state updates and readings for clients are now wrapped in a mutex Closes #492 (cherry picked from commit 11fb18f) --- src/octoprint/printer.py | 25 ++++++++++++++----------- src/octoprint/util/comm.py | 2 +- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/src/octoprint/printer.py b/src/octoprint/printer.py index f992b78d..fd48b743 100644 --- a/src/octoprint/printer.py +++ b/src/octoprint/printer.py @@ -677,6 +677,7 @@ class StateMonitor(object): self._offsets = {} self._changeEvent = threading.Event() + self._stateMutex = threading.Lock() self._lastUpdate = time.time() self._worker = threading.Thread(target=self._work) @@ -706,8 +707,9 @@ class StateMonitor(object): self._changeEvent.set() def setState(self, state): - self._state = state - self._changeEvent.set() + with self._stateMutex: + self._state = state + self._changeEvent.set() def setJobData(self, jobData): self._jobData = jobData @@ -725,16 +727,17 @@ class StateMonitor(object): while True: self._changeEvent.wait() - now = time.time() - delta = now - self._lastUpdate - additionalWaitTime = self._ratelimit - delta - if additionalWaitTime > 0: - time.sleep(additionalWaitTime) + with self._stateMutex: + now = time.time() + delta = now - self._lastUpdate + additionalWaitTime = self._ratelimit - delta + if additionalWaitTime > 0: + time.sleep(additionalWaitTime) - data = self.getCurrentData() - self._updateCallback(data) - self._lastUpdate = time.time() - self._changeEvent.clear() + data = self.getCurrentData() + self._updateCallback(data) + self._lastUpdate = time.time() + self._changeEvent.clear() def getCurrentData(self): return { diff --git a/src/octoprint/util/comm.py b/src/octoprint/util/comm.py index a15eb4de..98cb0eb9 100644 --- a/src/octoprint/util/comm.py +++ b/src/octoprint/util/comm.py @@ -340,11 +340,11 @@ class MachineCom(object): def close(self, isError = False): printing = self.isPrinting() or self.isPaused() if self._serial is not None: - self._serial.close() if isError: self._changeState(self.STATE_CLOSED_WITH_ERROR) else: self._changeState(self.STATE_CLOSED) + self._serial.close() self._serial = None if settings().get(["feature", "sdSupport"]): From e0a064a0fad347546eca76eced0c8e12c95a6ea0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Fri, 8 Aug 2014 17:00:39 +0200 Subject: [PATCH 11/24] Updated README to fit new installation procedure etc. --- README.md | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 562a0caf..f219d122 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,10 @@ and released under the [GNU Affero General Public License V3](http://www.gnu.org Its website can be found at [octoprint.org](http://octoprint.org). -Reporting bugs --------------- +Contributing +------------ -OctoPrint's issue tracker can be found [on Github](https://github.com/foosel/OctoPrint/issues). **Before opening a new -ticket please take a look at [this guide on how to file a bug report with OctoPrint](https://github.com/foosel/OctoPrint/wiki/How-to-file-a-bug-report).** - -Sending pull requests ---------------------- - -Please create all pull requests against the [devel branch](https://github.com/foosel/OctoPrint/tree/devel) of OctoPrint, as that one is used for developing new -features and then merged against master when those features are deemed mature enough for general consumption. In case -of bug fixes I'll take care to cherry pick them against master if the bugs they are fixing are critical. +Please see the project's [Contribution Guidelines](https://github.com/foosel/OctoPrint/blob/master/CONTRIBUTING.md). Installation ------------ @@ -32,10 +24,10 @@ which is a custom SD card image that includes OctoPrint plus dependencies. Dependencies ------------ -OctoPrint depends on a couple of python modules to do its job. Those are listed in requirements.txt and can be -installed using `pip`: +OctoPrint depends on a couple of python modules to do its job. Those are automatically installed when installing +OctoPrint via `setup.py`: - pip install -r requirements.txt + python setup.py install You should also do this after pulling from the repository, since the dependencies might have changed. @@ -44,7 +36,7 @@ OctoPrint currently only supports Python 2.7. Usage ----- -Just start the server via +From the source directory you can start the server via ./run @@ -70,6 +62,11 @@ e.g.: See `run --help` for further information. +Running the `setup.py` script also installs the `octoprint` startup script in your Python installation's scripts folder +(which depending on whether you installed OctoPrint globally or into a virtual env will be on your `PATH` or not). The +examples above also work with that startup script as it excepts the same parameters as `run`. + + Configuration ------------- @@ -79,8 +76,3 @@ at `~/Library/Application Support/OctoPrint` on MacOS. A comprehensive overview of all available configuration settings can be found [on the wiki](https://github.com/foosel/OctoPrint/wiki/Configuration). - -Setup on a Raspberry Pi running Raspbian ----------------------------------------- - -A comprehensive setup guide can be found [on the wiki](https://github.com/foosel/OctoPrint/wiki/Setup-on-a-Raspberry-Pi-running-Raspbian). From ee36c3163761800672a9fc34836dd6f975864fb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Mon, 23 Jun 2014 13:09:54 +0200 Subject: [PATCH 12/24] Added clean command to setup.py (cherry picked from commit 76a9e94) --- setup.py | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 21bed682..471e546f 100644 --- a/setup.py +++ b/setup.py @@ -8,8 +8,11 @@ versioneer.versionfile_build = 'octoprint/_version.py' versioneer.tag_prefix = '' versioneer.parentdir_prefix = '' -from setuptools import setup, find_packages +from setuptools import setup, find_packages, Command import os +import shutil +import glob + def package_data_dirs(source, sub_folders): dirs = [] @@ -22,10 +25,40 @@ def package_data_dirs(source, sub_folders): return dirs + +class CleanCommand(Command): + description = "clean build artifacts" + user_options = [] + boolean_options = [] + + def initialize_options(self): + pass + + def finalize_options(self): + pass + + def run(self): + if os.path.exists('build'): + print "Deleting build directory" + shutil.rmtree('build') + eggs = glob.glob('OctoPrint*.egg-info') + for egg in eggs: + print "Deleting %s directory" % egg + shutil.rmtree(egg) + + +def get_cmdclass(): + cmdclass = versioneer.get_cmdclass() + cmdclass.update({ + 'clean': CleanCommand + }) + return cmdclass + + def params(): name = "OctoPrint" version = versioneer.get_version() - cmdclass = versioneer.get_cmdclass() + cmdclass = get_cmdclass() description = "A responsive web interface for 3D printers" long_description = open("README.md").read() From f69abdcc14d1d0eca58af4543a407dcaf52ee30b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Mon, 23 Jun 2014 13:31:31 +0200 Subject: [PATCH 13/24] Version resource on API with API and software version (cherry picked from commit 907f505) --- src/octoprint/server/api/__init__.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/octoprint/server/api/__init__.py b/src/octoprint/server/api/__init__.py index 9ff5ae54..7e886e7a 100644 --- a/src/octoprint/server/api/__init__.py +++ b/src/octoprint/server/api/__init__.py @@ -30,6 +30,8 @@ from . import users as api_users from . import log as api_logs +VERSION = "1.0" + #~~ first run setup @@ -69,6 +71,14 @@ def apiPrinterState(): return jsonify(currentData) +@api.route("/version", methods=["GET"]) +@restricted_access +def apiVersion(): + return jsonify({ + "server": octoprint.server.VERSION, + "api": octoprint.server.api.VERSION + }) + #~~ system control From aefb72f7cce3d56fcbfc359c3657b9811fa43dca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Fri, 8 Aug 2014 17:06:43 +0200 Subject: [PATCH 14/24] API version 1.0 is too early, we'll set it to 0.1 for now until it is really stable and not missing things like system commands and such (cherry picked from commit 4d434d3) --- src/octoprint/server/api/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/octoprint/server/api/__init__.py b/src/octoprint/server/api/__init__.py index 7e886e7a..816d5187 100644 --- a/src/octoprint/server/api/__init__.py +++ b/src/octoprint/server/api/__init__.py @@ -30,7 +30,7 @@ from . import users as api_users from . import log as api_logs -VERSION = "1.0" +VERSION = "0.1" #~~ first run setup From 60cf0b10995ca9fcb4ee3fe484a64081f242eac3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Thu, 7 Aug 2014 09:55:50 +0200 Subject: [PATCH 15/24] Made the navbar static instead of fixed to improve usability on mobile devices This is just a hack really, the proper approach would be to finally move to a real responsive design, but this should prove as a valid workaround until that is realized. Closes #257 for now. (cherry picked from commit 02212bd) --- src/octoprint/static/less/octoprint.less | 13 ++++++------- src/octoprint/templates/index.jinja2 | 2 +- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/src/octoprint/static/less/octoprint.less b/src/octoprint/static/less/octoprint.less index 0acbf2e8..41292d54 100644 --- a/src/octoprint/static/less/octoprint.less +++ b/src/octoprint/static/less/octoprint.less @@ -6,7 +6,7 @@ // Body body { - padding-top: 60px; + //padding-top: 60px; } // Navigation bar @@ -113,9 +113,11 @@ body { } } -/** OctoPrint application tabs */ - .octoprint-container { + margin-top: 20px; + + /** OctoPrint application tabs */ + .tab-content { padding: 9px 15px; border-left: 1px solid #DDD; @@ -143,12 +145,9 @@ body { border-bottom: 1px solid #E5E5E5; font-weight: normal; } -} + /** Accordions */ -/** Accordions */ - -.octoprint-container { .accordion-heading { .accordion-heading-button { float: right; diff --git a/src/octoprint/templates/index.jinja2 b/src/octoprint/templates/index.jinja2 index fa5ebe7b..70c30fd6 100644 --- a/src/octoprint/templates/index.jinja2 +++ b/src/octoprint/templates/index.jinja2 @@ -42,7 +42,7 @@ -