diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 040cd9c..0000000 --- a/.travis.yml +++ /dev/null @@ -1,27 +0,0 @@ -language: python -matrix: - include: - - python: "2.7" - env: TOX_ENV=pep8 - - python: "2.7" - env: TOX_ENV=py27 - - python: "3.3" - env: TOX_ENV=py33 - - python: "3.4" - env: TOX_ENV=py34 - - python: "3.5" - env: TOX_ENV=py35 -before_install: - - sudo apt-get -qq update - - sudo apt-get install -y build-essential libcap-dev -install: - - pip install tox - - if [[ $TOX_ENV == py27 ]] || [[ $TOX_ENV == py35 ]]; then - pip install coveralls; - fi -script: - - tox -e $TOX_ENV -after_success: - - if [[ $TOX_ENV == py27 ]] || [[ $TOX_ENV == py35 ]]; then - coveralls; - fi diff --git a/Dockerfile b/Dockerfile index 6005872..f3dbe2c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,91 +1,19 @@ -FROM python:3.12.3 as build -MAINTAINER RAMS Project "code@magfest.org" -LABEL version.sideboard ="1.0" +FROM python:3.12.3-slim as build WORKDIR /app - -# This is actually the least bad way to compose two Dockerfile tech stacks right now. -# The following is copied and pasted from the Node Dockerfile at -# https://github.com/nodejs/docker-node/blob/main/12/buster/Dockerfile -# Update this comment and change the entire copypasta section to upgrade Node version - -######################################### -# START NODEJS DOCKERFILE COPYPASTA # -# https://github.com/nodejs/docker-node # -######################################### -RUN groupadd --gid 1000 node \ - && useradd --uid 1000 --gid node --shell /bin/bash --create-home node - -ENV NODE_VERSION 12.22.3 - -RUN ARCH= && dpkgArch="$(dpkg --print-architecture)" \ - && case "${dpkgArch##*-}" in \ - amd64) ARCH='x64';; \ - ppc64el) ARCH='ppc64le';; \ - s390x) ARCH='s390x';; \ - arm64) ARCH='arm64';; \ - armhf) ARCH='armv7l';; \ - i386) ARCH='x86';; \ - *) echo "unsupported architecture"; exit 1 ;; \ - esac \ - # gpg keys listed at https://github.com/nodejs/node#release-keys - && set -ex \ - && for key in \ - 4ED778F539E3634C779C87C6D7062848A1AB005C \ - 94AE36675C464D64BAFA68DD7434390BDBE9B9C5 \ - 74F12602B6F1C4E913FAA37AD3A89613643B6201 \ - 71DCFD284A79C3B38668286BC97EC7A07EDE3FC1 \ - 8FCCA13FEF1D0C2E91008E09770F7A9A5AE15600 \ - C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8 \ - C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C \ - DD8F2338BAE7501E3DD5AC78C273792F7D83545D \ - A48C2BEE680E841632CD4E44F07496B3EB3C1762 \ - 108F52B48DB57BB0CC439B2997B01419BD92F80A \ - B9E2F5981AA6E0CD28160D9FF13993A75599653C \ - ; do \ - gpg --batch --keyserver hkps://keys.openpgp.org --recv-keys "$key" || \ - gpg --batch --keyserver keyserver.ubuntu.com --recv-keys "$key" ; \ - done \ - && curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-$ARCH.tar.xz" \ - && curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/SHASUMS256.txt.asc" \ - && gpg --batch --decrypt --output SHASUMS256.txt SHASUMS256.txt.asc \ - && grep " node-v$NODE_VERSION-linux-$ARCH.tar.xz\$" SHASUMS256.txt | sha256sum -c - \ - && tar -xJf "node-v$NODE_VERSION-linux-$ARCH.tar.xz" -C /usr/local --strip-components=1 --no-same-owner \ - && rm "node-v$NODE_VERSION-linux-$ARCH.tar.xz" SHASUMS256.txt.asc SHASUMS256.txt \ - # smoke tests - && node --version \ - && npm --version - -RUN curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-x64.tar.xz" \ - && curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/SHASUMS256.txt.asc" \ - && gpg --batch --decrypt --output SHASUMS256.txt SHASUMS256.txt.asc \ - && grep " node-v$NODE_VERSION-linux-x64.tar.xz\$" SHASUMS256.txt | sha256sum -c - \ - && tar -xJf "node-v$NODE_VERSION-linux-x64.tar.xz" -C /usr/local --strip-components=1 \ - && rm "node-v$NODE_VERSION-linux-x64.tar.xz" SHASUMS256.txt.asc SHASUMS256.txt \ - && ln -s /usr/local/bin/node /usr/local/bin/nodejs -################################### -# END NODEJS DOCKERFILE COPYPASTA # -################################### - -# required for python-prctl -RUN apt-get update && apt-get install -y libcap-dev && rm -rf /var/lib/apt/lists/* - -RUN pip3 install virtualenv \ - && virtualenv --always-copy /app/env \ - && /app/env/bin/pip3 install paver +ENV PYTHONPATH=/app:/app/plugins/*/ ADD requirements.txt requirements.txt -ADD test_requirements.txt test_requirements.txt -ADD setup.py setup.py -ADD sideboard/_version.py sideboard/_version.py -ADD pavement.py pavement.py - -RUN /app/env/bin/paver install_deps -ADD . /app/ +RUN --mount=type=cache,target=/root/.cache \ + pip install -r requirements.txt FROM build as test -RUN /app/env/bin/pip install mock pytest -CMD /app/env/bin/python3 -m pytest +ADD test_requirements.txt test_requirements.txt +RUN --mount=type=cache,target=/root/.cache \ + pip install -r test_requirements.txt +CMD python -m pytest +ADD . /app/ FROM build as release -CMD /app/env/bin/python3 /app/sideboard/run_server.py -EXPOSE 8282 \ No newline at end of file +CMD python /app/sideboard/run_server.py +EXPOSE 80 +ADD . /app/ \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 9861bfd..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -include requirements.txt -recursive-include sideboard * \ No newline at end of file diff --git a/data/__init__.py b/data/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/data/paver/__init__.py b/data/paver/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/data/paver/skeleton/__init__.py b/data/paver/skeleton/__init__.py deleted file mode 100644 index a91f5a9..0000000 --- a/data/paver/skeleton/__init__.py +++ /dev/null @@ -1,89 +0,0 @@ -import os -import re -from datetime import datetime - -import six -import jinja2 -import sphinx.quickstart - -env = jinja2.Environment() - -__here__ = os.path.dirname(os.path.abspath(__file__)) - - -def render(to_render, settings): - if isinstance(to_render, six.string_types): - return env.from_string(to_render).render(settings) - else: - with open(os.path.join(__here__, *to_render)) as template_file: - return env.from_string(template_file.read()).render(settings) - - -def create_plugin(plugins_dir, plugin, **settings): - assert ' ' not in plugin, "plugins probably shouldn't have spaces; but either way we aren't specifically handling spaces" - module = plugin.replace('-', '_') - plugin = plugin.replace('_', '-') - settings.update({'plugin': plugin, 'module': module, 'generated_date': datetime.utcnow()}) - - package_dir = os.path.join(plugins_dir, plugin) - assert not os.path.exists(package_dir), '{} plugin already exists at {}'.format(plugin, package_dir) - os.makedirs(os.path.join(package_dir, module, 'tests')) - for fname, template in TEMPLATES.items(): - fname = render(fname, settings) - if fname: - fpath = os.path.join(package_dir, fname) - try: - os.makedirs(os.path.dirname(fpath)) - except (OSError, IOError) as e: - pass - - with open(fpath, 'w') as f: - # our templates often have a lot of {% if %} clauses which lead to a lot of blank lines, - # so we collapse those such that we never have more than 1 blank line in a row - f.write(re.sub(r'\n{3,}', '\n\n', render(template, settings).strip() + '\n')) - - if settings.get('sphinx', True): - sphinx_settings = dict( - path=os.path.join(package_dir, 'docs'), - sep=False, - dot='_', - project=plugin, - author='{} Team'.format(plugin), - release='0.1.0', - version='0.1.0', - suffix='.rst', - master='index', - epub=False, - ext_autodoc=False, - ext_doctest=False, - ext_intersphinx=False, - ext_todo=False, - ext_coverage=False, - ext_pngmath=False, - ext_mathjax=False, - ext_ifconfig=False, - ext_viewcode=False, - makefile=True, - batchfile=False - ) - sphinx.quickstart.generate(sphinx_settings) - -TEMPLATES = { - '{{ module }}/_version.py': ('templates', '_version.py.template'), - 'requirements.txt': ('templates', 'requirements.txt.template'), - 'setup.cfg': ('templates', 'setup.cfg.template'), - 'setup.py': ('templates', 'setup.py.template'), - 'conftest.py': ('templates', 'conftest.py.template'), - '{{ module }}/__init__.py': ('templates', '__init__.py.template'), - '{{ module }}/tests/__init__.py': ('templates', 'tests-__init__.py.template'), - '{% if sqlalchemy %}{{ module }}/sa.py{% endif %}': ('templates', 'sa.py.template'), - '{% if service %}{{ module }}/service.py{% endif %}': ('templates', 'service.py.template'), - '{{ module }}/configspec.ini': ('templates', 'configspec.ini.template'), - 'development-defaults.ini': ('templates', 'development-defaults.ini'), - '{% if webapp %}{{ module }}/templates/index.html{% endif %}': ('templates', 'index.html.template'), - 'MANIFEST.in': ('templates', 'MANIFEST.in.template'), - '.gitignore': ('templates', '.gitignore.template'), - 'fabfile.py': ('templates', 'fabfile.py.template'), - 'package-support/{{ plugin }}.cfg': ('templates', 'plugin_name.cfg.template'), - '{% if cli %}{{ module }}/cli.py{% endif %}': ('templates', 'cli.py.template'), -} diff --git a/data/paver/skeleton/templates/.gitignore.template b/data/paver/skeleton/templates/.gitignore.template deleted file mode 100644 index edc099b..0000000 --- a/data/paver/skeleton/templates/.gitignore.template +++ /dev/null @@ -1,5 +0,0 @@ -.idea -env -*.pyc -*.egg-info -dist \ No newline at end of file diff --git a/data/paver/skeleton/templates/MANIFEST.in.template b/data/paver/skeleton/templates/MANIFEST.in.template deleted file mode 100644 index 48c6b99..0000000 --- a/data/paver/skeleton/templates/MANIFEST.in.template +++ /dev/null @@ -1,2 +0,0 @@ -include requirements.txt -recursive-include {{ module }} * \ No newline at end of file diff --git a/data/paver/skeleton/templates/__init__.py.template b/data/paver/skeleton/templates/__init__.py.template deleted file mode 100644 index ec09510..0000000 --- a/data/paver/skeleton/templates/__init__.py.template +++ /dev/null @@ -1,61 +0,0 @@ -from __future__ import unicode_literals{% if django %} -import os -import sys -{% endif %} - -{% if webapp or django %} -import cherrypy -{% if django %} -import django -from django.core.handlers.wsgi import WSGIHandler -{% endif %} -{% endif %} - -from sideboard.lib import log, parse_config{% if webapp %}, render_with_templates{% endif %}{% if service or sqlalchemy %}, services{% endif %} -from {{ module }}._version import __version__ - -config = parse_config(__file__) - -{% if service %} -from {{ module }} import service -services.register(service, '{{ module }}') - -{% endif %} - -{% if sqlalchemy %} -from {{ module }} import sa -services.register(sa.Session.crud, '{{ module }}_crud') -{% endif %} - -{% if webapp %} -@render_with_templates(config['template_dir']) -class Root(object): - def index(self): - log.debug('this data will be used to render a template') - return { - 'plugin': '{{ plugin }}', - 'header': True - } - -cherrypy.tree.mount(Root(), '/{{ module }}') -{% endif %} - -{% if django %} -# add our Django site to our Python path so we can import it -sys.path.append(os.path.join(config['root'], '{{ django }}')) - -# since we're not using mod_wsgi we'll use the env var approach to setting up Django -os.environ['DJANGO_SETTINGS_MODULE'] = '{{ django }}.settings' -django.setup() -cherrypy.tree.graft(WSGIHandler(), '/{{ django }}') - -# expose the static files used by the Django admin interface -# NOTE: if you have Apache serving these files directly then you can remove this part -class Static(object): - admin = cherrypy.tools.staticdir.handler( - section="/admin", - dir=os.path.dirname(django.__file__) + '/contrib/admin/static/admin' - ) - -cherrypy.tree.mount(Static(), '/{{ django }}/static') -{% endif %} diff --git a/data/paver/skeleton/templates/_version.py.template b/data/paver/skeleton/templates/_version.py.template deleted file mode 100644 index 748c016..0000000 --- a/data/paver/skeleton/templates/_version.py.template +++ /dev/null @@ -1,3 +0,0 @@ -from __future__ import unicode_literals - -__version__ = '0.1.0' diff --git a/data/paver/skeleton/templates/cli.py.template b/data/paver/skeleton/templates/cli.py.template deleted file mode 100644 index 587a3cc..0000000 --- a/data/paver/skeleton/templates/cli.py.template +++ /dev/null @@ -1,13 +0,0 @@ -from __future__ import unicode_literals - -from sideboard.lib import entry_point, log -from {{ module }} import __version__ - -@entry_point -def {{ module }}(*args): - """ - Basic cli entry, logs the version of the plugin and then exits. Override after creating the - plugin - """ - - log.info('the version of {} is {}', '{{ module }}', __version__) diff --git a/data/paver/skeleton/templates/configspec.ini.template b/data/paver/skeleton/templates/configspec.ini.template deleted file mode 100644 index 72a90cf..0000000 --- a/data/paver/skeleton/templates/configspec.ini.template +++ /dev/null @@ -1,2 +0,0 @@ -{% if sqlalchemy %}sqlalchemy.url = string{% endif %} -{% if webapp %}template_dir = string(default="%(module_root)s/templates"){% endif %} diff --git a/data/paver/skeleton/templates/conftest.py.template b/data/paver/skeleton/templates/conftest.py.template deleted file mode 100644 index 98f0d86..0000000 --- a/data/paver/skeleton/templates/conftest.py.template +++ /dev/null @@ -1,21 +0,0 @@ -import sideboard -{% if sqlalchemy %} -import shutil -import pytest -from {{ plugin }} import sa -from sideboard.tests import patch_session - -@pytest.fixture(scope='session', autouse=True) -def init_db(request): - patch_session(sa.Session, request) # swap out your database for SQLite - with sa.Session() as session: - # You can initialize test data here, which will be inserted once when - # your tests start (which might be really slow) but then before each - # test case the database is restored again, which is really fast. - pass - -@pytest.fixture(autouse=True) -def db(request, init_db): - shutil.copy('/tmp/{{ plugin }}.db', '/tmp/{{ plugin }}.db.backup') - request.addfinalizer(lambda: shutil.move('/tmp/{{ plugin }}.db.backup', '/tmp/{{ plugin }}.db')) -{% endif %} diff --git a/data/paver/skeleton/templates/development-defaults.ini b/data/paver/skeleton/templates/development-defaults.ini deleted file mode 100644 index dcd5af9..0000000 --- a/data/paver/skeleton/templates/development-defaults.ini +++ /dev/null @@ -1 +0,0 @@ -{% if sqlalchemy %}sqlalchemy.url = "sqlite:////tmp/{{ plugin }}.db"{% endif %} \ No newline at end of file diff --git a/data/paver/skeleton/templates/fabfile.py.template b/data/paver/skeleton/templates/fabfile.py.template deleted file mode 100644 index aaa17f2..0000000 --- a/data/paver/skeleton/templates/fabfile.py.template +++ /dev/null @@ -1,44 +0,0 @@ -from __future__ import unicode_literals -import time -from os.path import abspath, basename, dirname, join - -from sh import pip, fpm, chmod - -__here__ = dirname(abspath(__file__)) -package_name = basename(__here__) -plugin_name = package_name.replace('-', '_') - -POSTINSTALL = '/tmp/postinstall.sh' - -def _make_postinstall_script(): - with open(POSTINSTALL, 'w') as f: - f.write('#!/bin/bash\n') - f.write('set -e\n') - f.write('source /opt/sideboard/bin/activate && /opt/sideboard/bin/pip install --use-wheel --find-links /opt/sideboard/plugins/{package_name}/wheelhouse/ -r /opt/sideboard/plugins/{package_name}/requirements.txt\n' - .format(package_name=package_name)) - f.write('chown -R sideboard.sideboard /opt/sideboard\n') - chmod('755', POSTINSTALL) - -def package(package_type, iteration='testing'): - import sideboard - plugin = __import__(plugin_name) - pip('wheel', r='requirements.txt') - _make_postinstall_script() - if iteration == 'testing': - iteration = '0.{}'.format(int(time.time())) - fpm('-t', package_type, - '-s', 'dir', - '--{}-user'.format(package_type), 'sideboard', - '--{}-group'.format(package_type), 'sideboard', - '--name', 'sideboard-{}'.format(package_name), - '--version', plugin.__version__, - '--license', 'COMPANY-PROPRIETARY', - '--iteration', iteration, - '--depends', 'sideboard >= {}'.format(sideboard.__version__), - '--after-install', POSTINSTALL, - '--config-files', '/etc/sideboard/plugins.d/{package_name}.cfg'.format(package_name=package_name), - './package-support/{package_name}.cfg=/etc/sideboard/plugins.d/{package_name}.cfg'.format(package_name=package_name), - './requirements.txt=/opt/sideboard/plugins/{}/requirements.txt'.format(package_name), - './wheelhouse=/opt/sideboard/plugins/{}'.format(package_name),{% if django %} - './{{ django }}=/opt/sideboard/plugins/{}/{{ django }}'.format(package_name),{% endif %} - './{}=/opt/sideboard/plugins/{}'.format(plugin_name, package_name)) diff --git a/data/paver/skeleton/templates/index.html.template b/data/paver/skeleton/templates/index.html.template deleted file mode 100644 index 0bbc0f1..0000000 --- a/data/paver/skeleton/templates/index.html.template +++ /dev/null @@ -1,9 +0,0 @@ -{% raw %} - - {{ plugin }} skeleton page - - {% if header %} -

Hello {{ plugin }} developer!

- {% endif %} - -{% endraw%} diff --git a/data/paver/skeleton/templates/plugin_name.cfg.template b/data/paver/skeleton/templates/plugin_name.cfg.template deleted file mode 100644 index e500cfb..0000000 --- a/data/paver/skeleton/templates/plugin_name.cfg.template +++ /dev/null @@ -1 +0,0 @@ -{% if sqlalchemy %}sqlalchemy.url = "sqlite:////opt/sideboard/db/{{ plugin }}.db"{% endif %} diff --git a/data/paver/skeleton/templates/requirements.txt.template b/data/paver/skeleton/templates/requirements.txt.template deleted file mode 100644 index e69de29..0000000 diff --git a/data/paver/skeleton/templates/sa.py.template b/data/paver/skeleton/templates/sa.py.template deleted file mode 100644 index e204dae..0000000 --- a/data/paver/skeleton/templates/sa.py.template +++ /dev/null @@ -1,18 +0,0 @@ -from __future__ import unicode_literals -import uuid - -import sqlalchemy -from sqlalchemy.schema import Column - -from {{ module }} import config -from sideboard.lib.sa import declarative_base, SessionManager, UUID - - -@declarative_base -class Base(object): - id = Column(UUID(), primary_key=True, default=uuid.uuid4) - -# put your table declarations here and have them extend Base - -class Session(SessionManager): - engine = sqlalchemy.create_engine(config['sqlalchemy.url']) diff --git a/data/paver/skeleton/templates/service.py.template b/data/paver/skeleton/templates/service.py.template deleted file mode 100644 index d18b3bc..0000000 --- a/data/paver/skeleton/templates/service.py.template +++ /dev/null @@ -1,9 +0,0 @@ -from __future__ import unicode_literals - -# underscore-prefixed functions are not exposed -def _greeting_impl(s): - return 'Hello {}!'.format(s) - -# all other methods are public -def greeting(): - return _greeting_impl('World') \ No newline at end of file diff --git a/data/paver/skeleton/templates/setup.cfg.template b/data/paver/skeleton/templates/setup.cfg.template deleted file mode 100644 index 9d29187..0000000 --- a/data/paver/skeleton/templates/setup.cfg.template +++ /dev/null @@ -1,2 +0,0 @@ -[easy_install] -zip_ok = False diff --git a/data/paver/skeleton/templates/setup.py.template b/data/paver/skeleton/templates/setup.py.template deleted file mode 100644 index ed4571c..0000000 --- a/data/paver/skeleton/templates/setup.py.template +++ /dev/null @@ -1,28 +0,0 @@ -from __future__ import unicode_literals - -import os.path -from setuptools import setup, find_packages - -pkg_name = '{{ plugin }}' -__here__ = os.path.abspath(os.path.dirname(__file__)) -# Sideboard's implementation of http://stackoverflow.com/a/16084844/171094 -# after this, __version__ should exist in the namespace -exec(open(os.path.join(__here__, pkg_name.replace('-', '_'), '_version.py')).read()) -req_data = open(os.path.join(__here__, 'requirements.txt')).read() -requires = [r.strip() for r in req_data.split() if r.strip() != ''] -requires = list(reversed(requires)) - -if __name__ == '__main__': - setup( - name=pkg_name, - version=__version__, - description='Sideboard ' + pkg_name + ' plugin', - license='COMPANY-PROPRIETARY', - scripts=[], - setup_requires=['distribute'], - install_requires=requires, - packages=find_packages(), - include_package_data=True, - package_data={}, - zip_safe=False - ) diff --git a/data/paver/skeleton/templates/tests-__init__.py.template b/data/paver/skeleton/templates/tests-__init__.py.template deleted file mode 100644 index 5a75852..0000000 --- a/data/paver/skeleton/templates/tests-__init__.py.template +++ /dev/null @@ -1,11 +0,0 @@ -from __future__ import unicode_literals -import pytest - - -# you can py.test-style test cases, with fixtures -@pytest.fixture -def boolean_true(): - return True - -def test_something_simple_the_pytest_way(boolean_true): - assert boolean_true != False diff --git a/data/sessions/.gitkeep b/data/sessions/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/db/README.txt b/db/README.txt deleted file mode 100644 index 2b09269..0000000 --- a/db/README.txt +++ /dev/null @@ -1,2 +0,0 @@ -Directory for plugins' sqlite files. Sideboard exposes this directory as a config option called 'sqlite_dir'. -In production, it's located at '/opt/sideboard/db/'. diff --git a/development-defaults.ini b/development-defaults.ini deleted file mode 100644 index eb39f37..0000000 --- a/development-defaults.ini +++ /dev/null @@ -1,10 +0,0 @@ -debug = False -ws.auth_required = False - -[cherrypy] -server.socket_host = "0.0.0.0" -engine.autoreload.on = True -tools.cpstats.on = False - -[loggers] -root = "DEBUG" diff --git a/fabfile.py b/fabfile.py deleted file mode 100644 index 04082a8..0000000 --- a/fabfile.py +++ /dev/null @@ -1,32 +0,0 @@ -from __future__ import unicode_literals -import time -import os.path - -import yaml -import ship_it - - -__here__ = os.path.abspath(os.path.dirname(__file__)) -MANIFEST_YAML = os.path.join(__here__, 'manifest.yaml') -MANIFEST_TEMPLATE = MANIFEST_YAML + '.template' - - -def _populate_manifest_and_invoke_fpm(iteration): - import sideboard - with open(MANIFEST_TEMPLATE) as f: - manifest = yaml.load(f) - manifest[b'version'] = sideboard.__version__ - manifest[b'iteration'] = iteration - - with open(MANIFEST_YAML, 'w') as f: - yaml.dump(manifest, f) - - ship_it.fpm(MANIFEST_YAML) - - -def fpm_stable(iteration): - _populate_manifest_and_invoke_fpm(iteration) - - -def fpm_testing(): - _populate_manifest_and_invoke_fpm(b'0.{}'.format(int(time.time()))) diff --git a/manifest.yaml.template b/manifest.yaml.template deleted file mode 100644 index 1a735a2..0000000 --- a/manifest.yaml.template +++ /dev/null @@ -1,10 +0,0 @@ -description: Sideboard Framework -name: sideboard -before_install: package-support/preinstall.sh -after_install: package-support/postinstall.sh -config_files: - /etc/sideboard/sideboard-server.cfg: package-support/sideboard-server.cfg - /etc/init.d/sideboard: package-support/init.d/sideboard - /etc/sysconfig/sideboard: package-support/sysconfig/sideboard -depends: - - python27 diff --git a/package-support/init.d/sideboard b/package-support/init.d/sideboard deleted file mode 100755 index 03383bd..0000000 --- a/package-support/init.d/sideboard +++ /dev/null @@ -1,181 +0,0 @@ -#!/bin/bash - -# chkconfig: - 88 14 -# description: Sideboard exit node manager -# processname: sideboard -# -### BEGIN INIT INFO -# Provides: sideboard -# Required-Start: $local_fs $remote_fs $network $named -# Required-Stop: $local_fs $remote_fs $network -# Short-Description: start and stop sideboard -# Description: Sideboard exit node manager -### END INIT INFO - -RETVAL=0 -prog="sideboard" - -DESC=sideboard -VENV=/opt/sideboard -PYTHON=$VENV/bin/python -SEP=$VENV/bin/sep -CHERRYD=$VENV/bin/cherryd -USER=sideboard -PID_FILE=/var/run/sideboard/sideboard.pid -COUNTDOWN=10 - -SIDEBOARDMODE=server -if [ -f /etc/sysconfig/sideboard ]; then - # import $SIDEBOARDMODE from defaults file -. /etc/sysconfig/sideboard -fi - -OPTIONS="mainloop_daemon --pidfile=$PID_FILE" -if [ "$SIDEBOARDMODE" == "server" ]; then - OPTIONS="-d --pidfile=$PID_FILE --import=sideboard.server" -fi - -procgrep() { - grep "python.*${DESC}" | grep -v grep -} - -filepid() { - cat $PID_FILE 2>/dev/null -} - -procpid() { - ps aux | procgrep | awk '{print $2}' -} - -allpids () { - FP=$(filepid) - PP=$(procpid) - if [ "$PP" == "$FP" ]; then - echo $PP - else - FP_IS_CORRECT_PROC=$(cat /proc/$FP/cmdline 2>/dev/null | procgrep) - if [ -n "$FP_IS_CORRECT_PROC" ]; then - echo $PP $FP - else - echo $PP - fi - fi -} - -isrunning() { - if [ -n "$(filepid)" ]; then - RETVAL=0 - elif [ -n "$(procpid)" ]; then - RETVAL=0 - else - RETVAL=1 - fi - return $RETVAL -} - -start() { - if isrunning; then - echo "Starting $prog: $prog is already running [FAIL]" - RETVAL=1 - else - echo -n $"Starting $prog: " - if [ "$SIDEBOARDMODE" == "server" ]; then - sudo -u $USER $CHERRYD $OPTIONS - else - sudo -u $USER $SEP $OPTIONS - fi - RETVAL=$? - if [ $RETVAL -eq 0 ]; then - echo '[OK]' - else - echo '[FAIL]' - fi - fi - return $RETVAL -} - -exitcountdown() { - while [ "$COUNTDOWN" -gt 0 ]; do - if [ -z "$(procpid)" ]; then - break - fi - echo -n . - sleep 1 - COUNTDOWN=`expr $COUNTDOWN - 1` - done -} - -stop() { - if isrunning; then - echo -n "Shutting down $prog" - kill $(allpids) 2>/dev/null - exitcountdown - if [ -n "$(procpid)" ]; then - echo -n " $prog failed to exit cleanly, terminating" - kill -9 $(allpids) 2>/dev/null - COUNTDOWN=3 - exitcountdown - fi - rm -f $PID_FILE - if isrunning; then - echo ' [FAIL]' - else - echo ' [OK]' - fi - RETVAL=0 - else - echo "$prog is not running" - RETVAL=1 - fi - return $RETVAL -} - -restart() { - stop - start -} - -condrestart() { - if isrunning; then - restart - fi -} - -status() { - if isrunning; then - FP=$(filepid) - PP=$(procpid) - if [ "$FP" == "$PP" ]; then - RETVAL=0 - echo "$prog is running with pid $PP" - else - RETVAL=1 - echo "$prog has a pidfile with pid ${FP:-} but a running process with pid ${PP:-}" - fi - else - RETVAL=3 - echo "$prog is not running" - fi - return $RETVAL -} - -case "$1" in - start) - start - ;; - stop) - stop - ;; - status) - status - ;; - restart) - restart - ;; - condrestart|try-restart) - condrestart - ;; - *) - echo $"Usage: $0 {start|stop|status|restart|condrestart}" - RETVAL=1 -esac diff --git a/package-support/postinstall.sh b/package-support/postinstall.sh deleted file mode 100644 index dad1b91..0000000 --- a/package-support/postinstall.sh +++ /dev/null @@ -1,16 +0,0 @@ - -for dname in /var/run/sideboard /var/tmp/sideboard /var/tmp/sideboard/sessions /opt/sideboard /opt/sideboard/db /opt/sideboard/plugins; do - mkdir -p $dname - chmod 750 $dname - chown sideboard.sideboard $dname -done - -# unlike all of the other directories in the above loop, we want this directory (and also its contents) to be sideboard.root -chown -R root.sideboard /etc/sideboard - -chown root.root /etc/init.d/sideboard -chown root.root /etc/sysconfig/sideboard - -# TODO: instead of doing this in postinstall, we should eventually do ---use-file-permissions -chmod 700 /etc/init.d/sideboard -chmod 600 /etc/sysconfig/sideboard diff --git a/package-support/preinstall.sh b/package-support/preinstall.sh deleted file mode 100644 index 36d0831..0000000 --- a/package-support/preinstall.sh +++ /dev/null @@ -1,5 +0,0 @@ - -if ! id -u sideboard &>/dev/null; then - groupadd --force -r sideboard -g 600 - useradd -r --shell /sbin/nologin -uid 600 --gid sideboard sideboard -fi diff --git a/package-support/sideboard-server.cfg b/package-support/sideboard-server.cfg deleted file mode 100644 index a1cf43f..0000000 --- a/package-support/sideboard-server.cfg +++ /dev/null @@ -1,22 +0,0 @@ -plugins_dir = "/opt/sideboard/plugins" - -[cherrypy] -server.socket_host = "127.0.0.1" -tools.sessions.storage_path = "/var/tmp/sideboard/sessions" - -[loggers] -root = "INFO" - -[handlers] -[[syslog]] -class = "logging.handlers.SysLogHandler" -address = "/dev/log" -formatter = syslog - -[formatters] -[[syslog]] -format = "$$(levelname)-5.5s $$(threadName)s [$$(name)s] $$(message)s" - -[[default]] -format = "$$(asctime)s,$$(msecs)03d $$(levelname)-5.5s $$(threadName)s [$$(name)s] $$(message)s" -datefmt = "$$m-$$d $$H:$$M:$$S" diff --git a/package-support/sysconfig/sideboard b/package-support/sysconfig/sideboard deleted file mode 100644 index 6b81aa9..0000000 --- a/package-support/sysconfig/sideboard +++ /dev/null @@ -1,6 +0,0 @@ -# defaults for sideboard package -# SIDEBOARDMODE=server -SIDEBOARDMODE=daemon - -# DESC=sideboard -DESC=sideboard-daemon diff --git a/pavement.py b/pavement.py deleted file mode 100644 index 404242b..0000000 --- a/pavement.py +++ /dev/null @@ -1,193 +0,0 @@ -from __future__ import unicode_literals, print_function -import os -import sys -import glob -from itertools import chain -from os.path import abspath, dirname, exists, join - -import paver.virtual as virtual -from paver.easy import * # paver docs pretty consistently want you to do this -from paver.path import path # primarily here to support the rmtree method of a path object - -__here__ = path(abspath(dirname(__file__))) -PLUGINS_DIR = __here__ / path('plugins') -SIDEBOARD_DIR = __here__ / path('sideboard') - - -def bootstrap_venv(intended_venv, bootstrap_name=None): - # bootstrap wants options available in options.virtualenv which is a Bunch - if exists(intended_venv): - intended_venv.rmtree() - - venv = getattr(options, 'virtualenv', Bunch()) - - with open(path(dirname(intended_venv)) / path('requirements.txt')) as reqs: - # we expect this to be reversed in setup.py - venv.packages_to_install = [line.strip() for line in reqs.readlines()[::-1] if line.strip()] - - venv.dest_dir = intended_venv - if bootstrap_name: - venv.script_name = '{}-bootstrap.py'.format(bootstrap_name) - - options.virtualenv = venv - virtual.bootstrap() - if sys.executable: - # if we can figure out the python associated with this paver, execute the bootstrap script - # and we can expect the virtual env will then exist - sh('{python_path} "{script_name}"'.format(python_path=sys.executable, - script_name=venv.script_name)) - - -def guess_plugin_module_name(containing_folder): - """ - given a containing folder, guess what the plugin name should be - - :param containing_folder: the folder that possibly contains a plugin - :type containing_folder: unicode - :return: - """ - # TODO: this only works as long as insist that the plugin dir be the module name - return os.path.split(containing_folder)[-1].replace('-', '_') - - -def collect_plugin_dirs(module=False): - """ - :param module: if True, return the module within a plugin directory, else (default) just return - the plugin directory - :return: the plugin folders in a form that can be iterated over - :rtype: collections.Iterator - """ - for potential_folder in glob.glob(PLUGINS_DIR / path('*')): - if all(exists(join(potential_folder, req_file)) for req_file in ('setup.py', 'requirements.txt')): - if module: - yield join(potential_folder, guess_plugin_module_name(potential_folder)) - else: - yield potential_folder - - -@task -def make_venv(): - """ - make a virtualenv for the sideboard project - """ - bootstrap_venv(__here__ / path('env'), 'sideboard') - develop_sideboard() - - -def install_pip_requirements_in_dir(dir_of_requirements_txt): - path_to_pip = __here__ / path('env/bin/pip') - - print("---- installing dependencies in {} ----" - .format(dir_of_requirements_txt)) - - sh('{pip} install -e {dir_of_requirements_txt}' - .format( - pip=path_to_pip, - dir_of_requirements_txt=dir_of_requirements_txt)) - - -def run_setup_py(path): - venv_python = str(__here__ / 'env' / 'bin' / 'python') - sh('cd {path} && {python_path} {setup_path} develop' - .format( - path=path, - python_path=venv_python if exists(venv_python) else sys.executable, - setup_path=join(path, 'setup.py'))) - - -def develop_sideboard(): - run_setup_py(__here__) - - -@task -def pull_plugins(): - """ - invoke git pull from each plug-in directory, your global git either needs to allow this to \ -happen auth-free, or you need to enter your credentials each time - """ - for plugin_dir in collect_plugin_dirs(): - sh('cd "{}";git pull'.format(plugin_dir)) - - -@task -def assert_all_projects_correctly_define_a_version(): - """ - error if there are plugins where we can't find a version defined - """ - all_files_with_bad_versions = [] - # FIXME: should we try to execfile? that's what setup.py is going to do anyway - cmd = (r'grep -xP "__version__\s*=\s*[\'\"][0-9]+\.[0-9]+(\.[0-9]+)?[\'\+]" {0}/_version.py') - for test_dir in chain(['sideboard'], collect_plugin_dirs(module=True)): - try: - sh(cmd.format(test_dir)) - except BuildFailure: - all_files_with_bad_versions.append(test_dir) - - if all_files_with_bad_versions: - print('the following directories do not include a _version.py file with __version__ ' - 'specified:') - print('\n'.join(all_files_with_bad_versions)) - print('Your plugin should be in agreement with this stack overflow post:') - print('http://stackoverflow.com/questions/458550/' - 'standard-way-to-embed-version-into-python-package/7071358#7071358') - - raise BuildFailure("there were projects that didn't include correctly specify __version__") - - -@task -@needs(['assert_all_files_import_unicode_literals', - 'assert_all_projects_correctly_define_a_version']) -def run_all_assertions(): - """ - run all the assertion tasks that sideboard supports - """ - - -@task -@cmdopts([ - ('name=', 'n', 'name of the plugin to create'), - ('drop', 'd', 'delete existing plugin if present'), - ('no_webapp', 'w', 'do not expose webpages in the plugin'), - ('no_sqlalchemy', 'a', 'do not use SQLAlchemy in the plugin'), - ('no_service', 'r', 'do not expose a service in the plugin'), - ('no_sphinx', 's', 'do not generate Sphinx docs'), - ('django=', 'j', 'create a Django project alongside the plugin with this name'), - ('cli', 'c', 'make this a cli application; implies -w/-r') -]) -def create_plugin(options): - """create a plugin skeleton to start a new project""" - - plugin_name = options.create_plugin.name - - if getattr(options.create_plugin, 'drop', False) and (PLUGINS_DIR / path(plugin_name.replace('_', '-'))).exists(): - # rmtree fails if the dir doesn't exist apparently - (PLUGINS_DIR / path(plugin_name.replace('_', '-'))).rmtree() - - kwargs = {} - for opt in ['webapp', 'sqlalchemy', 'service', 'sphinx']: - kwargs[opt] = not getattr(options.create_plugin, 'no_' + opt, False) - kwargs['cli'] = getattr(options.create_plugin, 'cli', False) - kwargs['django'] = getattr(options.create_plugin, 'django', None) - if kwargs['cli']: - kwargs['webapp'] = False - kwargs['service'] = False - - from data.paver import skeleton - skeleton.create_plugin(PLUGINS_DIR, plugin_name, **kwargs) - print('{} successfully created'.format(options.create_plugin.name)) - - -@task -def install_deps(): - install_pip_requirements_in_dir(__here__) - for pdir in collect_plugin_dirs(): - install_pip_requirements_in_dir(pdir) - - -@task -def clean(): - """ - clean all pyc and __pycache__ files - """ - sh("find . -name '*.pyc' | xargs rm -f") - sh("find . -name __pycache__ | xargs rm -fr") diff --git a/requirements.txt b/requirements.txt index b701108..0fbb1c5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,15 +1,5 @@ cherrypy==18.9.0 configobj==5.0.8 -Jinja2==3.1.3 -paver==1.3.4 -pip==24.0 psutil==5.9.8 -python-prctl==1.8.1; 'linux' in sys_platform +pyyaml==6.0.1 redis==5.0.3 -requests==2.31.0 -rpctools==0.3.1 -sh==2.0.6 -six==1.16.0 -SQLAlchemy==1.4.52 -wheel==0.43.0 -ws4py==0.5.1 diff --git a/sideboard/__init__.py b/sideboard/__init__.py index 825ec9a..ef3ee86 100644 --- a/sideboard/__init__.py +++ b/sideboard/__init__.py @@ -2,16 +2,12 @@ import os import importlib -import six import cherrypy from sideboard._version import __version__ import sideboard.server from sideboard.internal.imports import _discover_plugins -from sideboard.internal.logging import _configure_logging -import sideboard.run_mainloop if 'SIDEBOARD_MODULE_TESTING' not in os.environ: _discover_plugins() - _configure_logging() diff --git a/sideboard/_version.py b/sideboard/_version.py index 5b59135..946708c 100644 --- a/sideboard/_version.py +++ b/sideboard/_version.py @@ -1,3 +1,3 @@ from __future__ import unicode_literals -__version__ = '1.0.14' +__version__ = '2024.04' diff --git a/sideboard/config.py b/sideboard/config.py index d6a27b2..5d47ba4 100755 --- a/sideboard/config.py +++ b/sideboard/config.py @@ -1,9 +1,10 @@ from __future__ import unicode_literals +import pathlib +import json +import yaml import os -import re from os import unlink -from collections.abc import Sized, Iterable, Mapping from copy import deepcopy from tempfile import NamedTemporaryFile @@ -11,82 +12,6 @@ from validate import Validator -def uniquify(xs): - """ - Returns an order-preserved copy of `xs` with duplicate items removed. - - >>> uniquify(['a', 'z', 'a', 'b', 'a', 'y', 'a', 'c', 'a', 'x']) - ['a', 'z', 'b', 'y', 'c', 'x'] - - """ - is_listy = isinstance(xs, Sized) \ - and isinstance(xs, Iterable) \ - and not isinstance(xs, (Mapping, type(b''), type(''))) - assert is_listy, 'uniquify requires a listy argument' - - seen = set() - return [x for x in xs if x not in seen and not seen.add(x)] - - -class ConfigurationError(RuntimeError): - pass - - -def get_config_overrides(): - """ - Returns a list of config file paths used to override the default config. - - The SIDEBOARD_CONFIG_OVERRIDES environment variable may be set to a - semicolon separated list of absolute and/or relative paths. If the - SIDEBOARD_CONFIG_OVERRIDES is set, this function returns a list of its - contents, split on semicolons:: - - # SIDEBOARD_CONFIG_OVERRIDES='/absolute/config.ini;relative/config.ini' - return ['/absolute/config.ini', 'relative/config.ini'] - - If any of the paths listed in SIDEBOARD_CONFIG_OVERRIDES ends with the - suffix "-defaults." then a similarly named path - "." will also be included:: - - # SIDEBOARD_CONFIG_OVERRIDES='test-defaults.ini' - return ['test-defaults.ini', 'test.ini'] - - If the SIDEBOARD_CONFIG_OVERRIDES environment variable is NOT set, this - function returns a list with two relative paths:: - - return ['development-defaults.ini', 'development.ini'] - """ - config_overrides = os.environ.get( - 'SIDEBOARD_CONFIG_OVERRIDES', - 'development-defaults.ini') - - defaults_re = re.compile(r'(.+)-defaults(\.\w+)$') - config_paths = [] - for config_path in uniquify([s.strip() for s in config_overrides.split(';')]): - config_paths.append(config_path) - m = defaults_re.match(config_path) - if m: - config_paths.append(m.group(1) + m.group(2)) - - return config_paths - - -def get_config_root(): - """ - Returns the config root for the system, defaults to '/etc/sideboard'. - - If the SIDEBOARD_CONFIG_ROOT environment variable is set, its contents - will be returned instead. - """ - default_root = '/etc/sideboard' - config_root = os.environ.get('SIDEBOARD_CONFIG_ROOT', default_root) - if config_root != default_root and not os.path.isdir(config_root): - raise AssertionError('cannot find {!r} directory'.format(config_root)) - elif os.path.isdir(config_root) and not os.access(config_root, os.R_OK): - raise AssertionError('{!r} directory is not readable'.format(config_root)) - return config_root - - def get_module_and_root_dirs(requesting_file_path, is_plugin): """ Returns the "module_root" and "root" directories for the given file path. @@ -114,63 +39,28 @@ def get_module_and_root_dirs(requesting_file_path, is_plugin): Sideboard itself is making the request. Returns: - tuple(str): The "module_root" and "root" directories for the + tuple(Path, Path, str): The "module_root" and "root" directories, and plugin name for the given module. """ - module_dir = os.path.dirname(os.path.abspath(requesting_file_path)) + module_dir = pathlib.Path(requesting_file_path).parents[0] if is_plugin: from sideboard.lib import config - plugin_name = os.path.basename(module_dir) - root_dir = os.path.join(config['plugins_dir'], plugin_name) - if '_' in plugin_name and not os.path.exists(root_dir): - root_dir = os.path.join(config['plugins_dir'], plugin_name.replace('_', '-')) + plugin_name = module_dir.name + root_dir = pathlib.Path(config['plugins_dir']) / plugin_name + if '_' in plugin_name and not root_dir.exists(): + root_dir = pathlib.Path(config['plugins_dir']) / plugin_name.replace('_', '-') else: - root_dir = os.path.realpath(os.path.join(module_dir, '..')) - return module_dir, root_dir + root_dir = module_dir.parents[0] + plugin_name = "sideboard" + return module_dir, root_dir, plugin_name def get_config_files(requesting_file_path, is_plugin): """ Returns a list of absolute paths to config files for the given file path. - - When the returned config files are parsed by ConfigObj each subsequent - file will override values in earlier files. - - If `is_plugin` is `True` the first of the returned files is: - - * /etc/sideboard/plugins.d/.cfg, which is the config file we - expect in production - - - If `is_plugin` is `False` the first two returned files are: - - * /etc/sideboard/sideboard-core.cfg, which is the sideboard core config - file we expect in production - - * /etc/sideboard/sideboard-server.cfg, which is the sideboard server config - file we expect in production - - - The rest of the files returned are as follows, though we wouldn't - necessarily expect these to exist on a production install (these are - controlled by SIDEBOARD_CONFIG_OVERRIDES): - - * /development-defaults.ini, which can be checked into source - control and include whatever we want to be present in a development - environment. - - * /development.ini, which shouldn't be checked into source - control, allowing a developer to include local settings not shared with - others. - - - When developing on a machine with an installed production config file, we - might want to ignore the "real" config file and limit ourselves to only the - development files. This behavior is turned on by setting the environment - variable SIDEBOARD_MODULE_TESTING to any value. (This environment variable - is also used elsewhere to turn off automatically loading all plugins in - order to facilitate testing modules which rely on Sideboard but which are - not themselves Sideboard plugins.) + + If the file is in a plugin we check the environment variable + _CONFIG_FILES and return any paths from there, seperated by ; Args: requesting_file_path (str): The Python __file__ of the module @@ -182,24 +72,56 @@ def get_config_files(requesting_file_path, is_plugin): Returns: list(str): List of absolute paths to config files for the given module. """ - config_root = get_config_root() - module_dir, root_dir = get_module_and_root_dirs(requesting_file_path, is_plugin) - module_name = os.path.basename(module_dir) - - if 'SIDEBOARD_MODULE_TESTING' in os.environ: - base_configs = [] - elif is_plugin: - base_configs = [os.path.join(config_root, 'plugins.d', '{}.cfg'.format(module_name.replace('_', '-')))] - else: - assert module_name == 'sideboard', 'Unexpected module name {!r} requesting "non-plugin" configuration files'.format(module_name) - base_configs = [ - os.path.join(config_root, 'sideboard-core.cfg'), - os.path.join(config_root, 'sideboard-server.cfg') - ] - - config_overrides = [os.path.join(root_dir, config_path) for config_path in get_config_overrides()] - return base_configs + config_overrides - + module_dir, root_dir, plugin_name = get_module_and_root_dirs(requesting_file_path, is_plugin) + config_files_str = os.environ.get(f"{plugin_name.upper()}_CONFIG_FILES", "") + absolute_config_files = [] + if config_files_str: + config_files = [pathlib.Path(x) for x in config_files_str.split(";")] + for path in config_files: + if path.is_absolute(): + if not path.exists(): + raise ValueError(f"Config file {path} specified in {plugin_name.upper()}_CONFIG_FILES does not exist!") + absolute_config_files.append(path) + else: + if not (root_dir / path).exists(): + raise ValueError(f"Config file {root_dir / path} specified in {plugin_name.upper()}_CONFIG_FILES does not exist!") + absolute_config_files.append(root_dir / path) + return absolute_config_files + +def normalize_name(name): + return name.replace(".", "_") + +def load_section_from_environment(path, section): + """ + Looks for configuration in environment variables. + + Args: + path (str): The prefix of the current config section. For example, + sideboard.ini: + [cherrypy] + server.thread_pool: 10 + would translate to sideboard_cherrypy_server.thread_pool + section (configobj.ConfigObj): The section of the configspec to search + for the current path in. + """ + config = {} + for setting in section: + if setting == "__many__": + prefix = f"{path}_" + for envvar in os.environ: + if envvar.startswith(prefix) and not envvar.split(prefix, 1)[1] in [normalize_name(x) for x in section]: + config[envvar.split(prefix, 1)[1]] = os.environ[envvar] + else: + if isinstance(section[setting], configobj.Section): + child_path = f"{path}_{setting}" + child = load_section_from_environment(child_path, section[setting]) + if child: + config[setting] = child + else: + name = normalize_name(f"{path}_{setting}") + if name in os.environ: + config[setting] = yaml.safe_load(os.environ.get(normalize_name(name))) + return config def parse_config(requesting_file_path, is_plugin=True): """ @@ -225,10 +147,10 @@ def parse_config(requesting_file_path, is_plugin=True): Returns: ConfigObj: The resulting configuration object. """ - module_dir, root_dir = get_module_and_root_dirs(requesting_file_path, is_plugin) + module_dir, root_dir, plugin_name = get_module_and_root_dirs(requesting_file_path, is_plugin) - specfile = os.path.join(module_dir, 'configspec.ini') - spec = configobj.ConfigObj(specfile, interpolation=False, list_values=False, encoding='utf-8', _inspec=True) + specfile = module_dir / 'configspec.ini' + spec = configobj.ConfigObj(str(specfile), interpolation=False, list_values=False, encoding='utf-8', _inspec=True) # to allow more/better interpolations root_conf = ['root = "{}"\n'.format(root_dir), 'module_root = "{}"\n'.format(module_dir)] @@ -236,7 +158,17 @@ def parse_config(requesting_file_path, is_plugin=True): for config_path in get_config_files(requesting_file_path, is_plugin): # this gracefully handles nonexistent files - temp_config.merge(configobj.ConfigObj(config_path, encoding='utf-8', interpolation=False)) + file_config = configobj.ConfigObj(str(config_path), encoding='utf-8', interpolation=False) + if os.environ.get("LOG_CONFIG", "false").lower() == "true": + print(f"File config for {plugin_name} from {config_path}") + print(json.dumps(file_config, indent=2, sort_keys=True)) + temp_config.merge(file_config) + + environment_config = load_section_from_environment(plugin_name, spec) + if os.environ.get("LOG_CONFIG", "false").lower() == "true": + print(f"Environment config for {plugin_name}") + print(json.dumps(environment_config, indent=2, sort_keys=True)) + temp_config.merge(configobj.ConfigObj(environment_config, encoding='utf-8', interpolation=False)) # combining the merge files to one file helps configspecs with interpolation with NamedTemporaryFile(delete=False) as config_outfile: @@ -249,16 +181,12 @@ def parse_config(requesting_file_path, is_plugin=True): unlink(temp_name) if validation is not True: - raise ConfigurationError('configuration validation error(s) (): {!r}'.format( + raise RuntimeError('configuration validation error(s) (): {!r}'.format( configobj.flatten_errors(config, validation)) ) if is_plugin: sideboard_config = globals()['config'] - config['plugins'] = deepcopy(sideboard_config['plugins']) - if 'rpc_services' in config: - from sideboard.lib._services import _register_rpc_services - _register_rpc_services(config['rpc_services']) if 'default_url' in config: priority = config.get('default_url_priority', 0) diff --git a/sideboard/configspec.ini b/sideboard/configspec.ini index 87b9a6d..b357730 100644 --- a/sideboard/configspec.ini +++ b/sideboard/configspec.ini @@ -28,46 +28,10 @@ client_key = string(default="") client_cert = string(default="") ssl_version = string(default="PROTOCOL_TLSv1") -ws.thread_pool = integer(default=25) -ws.call_timeout = integer(default=10) # seconds -ws.poll_interval = integer(default=300) # seconds -ws.reconnect_interval = integer(default=60) # seconds - -# Sideboard exposes a websocket at /ws and by default requires a logged-in -# user to work. This setting can turn off that authentication check, which is -# useful for development or for applications which require no authentication. -ws.auth_required = boolean(default=True) - -# When performing authentication for the /ws websocket endpoint, this setting -# determines which session field must be set for the request to be considered -# "logged in". If your application sets a session field other than "username" -# when a user logs in, you should change this setting to the name of that field. -ws.auth_field = string(default="username") - -# When an authenticated websocket is established on the /ws endpoint, we copy -# this configurable list of session fields into the websocket and make them -# available as threadlocal fields on every websocket RPC requests. By default -# we only do this with the username of the logged-in user, but applications -# which store other data for logged in users can add those fields to this list. -ws.session_fields = string_list(default=list("username")) - -# When a frontend server permforms authentication before proxying a request, -# the username is often placed in an HTTP header. We copy this configureable -# list of HTTP headers and make them available on every websocket RPC request -# as fields inside threadlocal['headers'] -ws.header_fields = string_list(default=list()) - # If the "debug" option is set, the default login form will allow people to log # in with any username using this password. debug_password = string(default="testpassword") -# Sideboard has numerous background threads which wait on sideboard.lib.stopped -# to either sleep or bail immediately on shutdown. Since these threads wait in -# a loop, we don't want to set an interval too small or we'll eat a lot of CPU -# while doing absolutely nothing. A hard-coded value of 1 second would probably -# be fine for all workloads, but we've made it configurable just in case. -thread_wait_interval = float(default=1) - # Plugins can register different authenticators, since different applications may # have different ideas about what it means to be "logged in". The default # authenticator is mainly used for the /ws and /json RPC endpoints, so this @@ -76,10 +40,6 @@ thread_wait_interval = float(default=1) default_authenticator = string(default="default") -[plugins] -sqlite_dir = string(default="%(root)s/db") - - [cherrypy] checker.check_skipped_app_config = boolean(default=False) @@ -117,27 +77,30 @@ profiling.aggregate = boolean(default=False) profiling.strip_dirs = boolean(default=False) server.socket_host = string(default="127.0.0.1") -server.socket_port = integer(default=8282) - -tools.reset_threadlocal.on = boolean(default=True) +server.socket_port = integer(default=80) +server.thread_pool = integer(default=10) tools.sessions.on = boolean(default=True) tools.sessions.path = string(default="/") -tools.sessions.timeout = integer(default=30) +tools.sessions.timeout = integer(default=60) tools.sessions.storage_type = string(default="file") tools.sessions.storage_path = string(default="%(root)s/data/sessions") tools.sessions.secure = boolean(default=False) +tools.sessions.prefix = string(default=sideboard) + +# RedisSession specific values +tools.sessions.host = string(default="127.0.0.1") +tools.sessions.port = integer(default=6379) +tools.sessions.db = integer(default=0) +tools.sessions.password = string(default=None) +tools.sessions.tls_skip_verify = boolean(default=False) +tools.sessions.is_sentinel = boolean(default=False) +tools.sessions.ssl = boolean(default=False) +tools.sessions.user = string(default="") # Built-in CherryPy web server stats page tools.cpstats.on = boolean(default=False) -[rpc_services] -___many___ = string - -[[__many__]] -jsonrpc_only = boolean(default=False) - - [loggers] root = option("TRACE", "DEBUG", "INFO", "WARN", "WARNING", "ERROR", "CRITICAL", default="DEBUG") cherrypy.error = option("TRACE", "DEBUG", "INFO", "WARNING", "WARN", "ERROR", "CRITICAL", default="DEBUG") @@ -145,6 +108,10 @@ cherrypy.access = option("TRACE", "DEBUG", "INFO", "WARNING", "WARN", "ERROR", " __many__ = option("TRACE", "DEBUG", "INFO", "WARN", "WARNING", "ERROR", "CRITICAL", default="INFO") [handlers] +[[stdout]] +class = string(default="logging.StreamHandler") +stream = string(default="ext://sys.stdout") +formatter = string(default="indent_multiline") [[__many__]] formatter = string(default="default") ___many___ = string() diff --git a/sideboard/internal/autolog.py b/sideboard/internal/autolog.py deleted file mode 100755 index 7508f14..0000000 --- a/sideboard/internal/autolog.py +++ /dev/null @@ -1,243 +0,0 @@ -from __future__ import absolute_import, unicode_literals -import sys -import logging -import inspect - - -class EagerFormattingAdapter(logging.LoggerAdapter): - """ - A `logging.LoggerAdapter` that add unterpolation support but performs the - evaluation immediately if the appropriate loglevel is set. - """ - - def __init__(self, logger, extra=None): - """ - Initialize the adapter with a logger and a dict-like object which - provides contextual information. This constructor signature allows - easy stacking of LoggerAdapters, if so desired. - - You can effectively pass keyword arguments as shown in the - following example: - - adapter = LoggerAdapter(someLogger, dict(p1=v1, p2="v2")) - """ - self.logger = logger - self.extra = extra - - def _eagerFormat(self, msg, level, args): - """ - Eagerly apply log formatting if the appropriate level is enabled. - - Otherwise we just drop the log message (and return a string indicating - that it was suppreseed). - """ - if self.isEnabledFor(level): - # Do the string formatting immediately. - if args: - return self._getUnterpolatedMessage(msg, args) - else: - return msg - else: - # Otherwise, just drop the message completely to avoid anything going - # wrong in the future. This text shoudl clue one in to what's going - # on in the bizarre edge case where this ever does show up. - return '(log message suppressed due to insufficient log level)' - - def _getUnterpolatedMessage(self, msg, args): - """ - Returns the formatted string, will first attempt str.format and will - fallback to msg % args as it was originally. - - This is lifted almost wholesale from logging_unterpolation. - """ - original_msg = msg - if isinstance(args, dict): - # special case handing for unpatched logging supporting - # statements like: - # logging.debug("a %(a)d b %(b)s", {'a':1, 'b':2}) - args = (args,) - - try: - msg = msg.format(*args) - except UnicodeEncodeError: - # This is most likely due to formatting a non-ascii string argument - # into a bytestring, which the %-operator automatically handles - # by casting the left side (the "msg" variable) in this context - # to unicode. So we'll do that here - - if sys.version_info >= (3, 0,): - # this is most likely unnecessary on python 3, but it's here - # for completeness, in the case of someone manually creating - # a bytestring - unicode_type = str - else: - unicode_type = unicode - - # handle the attempt to print utf-8 encoded data, similar to - # %-interpolation's handling of unicode formatting non-ascii - # strings - msg = unicode_type(msg).format(*args) - - except ValueError: - # From PEP-3101, value errors are of the type raised by the format - # method itself, so see if we should fall back to original - # formatting since there was an issue - if '%' in msg: - msg = msg % args - else: - # we should NOT fall back, since there's no possible string - # interpolation happening and we want a meaningful error - # message - raise - - if msg == original_msg and '%' in msg: - # there must have been no string formatting methods - # used, given the presence of args without a change in the msg - # fall back to original formatting, including the special case - # for one passed dictionary argument - msg = msg % args - - return msg - - def debug(self, msg, *args, **kwargs): - """ - Delegate a debug call to the underlying logger, after adding - contextual information from this adapter instance. - """ - self.log(logging.DEBUG, msg, *args, **kwargs) - - def info(self, msg, *args, **kwargs): - """ - Delegate an info call to the underlying logger, after adding - contextual information from this adapter instance. - """ - self.log(logging.INFO, msg, *args, **kwargs) - - def warning(self, msg, *args, **kwargs): - """ - Delegate a warning call to the underlying logger, after adding - contextual information from this adapter instance. - """ - self.log(logging.WARNING, msg, *args, **kwargs) - - def warn(self, msg, *args, **kwargs): - """ - Delegate a warning call to the underlying logger, after adding - contextual information from this adapter instance. - """ - self.log(logging.WARNING, msg, *args, **kwargs) - - def error(self, msg, *args, **kwargs): - """ - Delegate an error call to the underlying logger, after adding - contextual information from this adapter instance. - """ - self.log(logging.ERROR, msg, *args, **kwargs) - - def exception(self, msg, *args, **kwargs): - """ - Delegate an exception call to the underlying logger, after adding - contextual information from this adapter instance. - """ - kwargs["exc_info"] = 1 - self.log(logging.ERROR, msg, *args, **kwargs) - - def critical(self, msg, *args, **kwargs): - """ - Delegate a critical call to the underlying logger, after adding - contextual information from this adapter instance. - """ - self.log(logging.CRITICAL, msg, *args, **kwargs) - - def log(self, level, msg, *args, **kwargs): - """ - Delegate a log call to the underlying logger, after adding - contextual information from this adapter instance. - """ - msg, kwargs = self.process(msg, kwargs) - # We explicitly do not pass the args into the log method here, since - # they should be "used up" by the eagerFormat method. - self.logger.log(level, self._eagerFormat(msg, level, args), **kwargs) - - -class AutoLogger(object): - """ - A logger proxy object, with all of the methods and attributes of C{Logger}. - - When an attribute (e.g., "debug") is requested, inspects the stack for the - calling module's name, and passes that name to C{logging.getLogger}. - - What this means is that you can instantiate an C{AutoLogger} anywhere, and - when you call it, the log entry shows the module where you called it, not - where it was created. - - C{AutoLogger} also inspects the local variables where it is called, looking - for C{self}. If C{self} exists, its classname is added to the module name. - """ - - def __init__(self, adapter_class=None, adapter_args=None, - adapter_kwargs=None): - if adapter_args is None: - adapter_args = [] - if adapter_kwargs is None: - adapter_kwargs = {} - - self.adapter_class = adapter_class - self.adapter_args = adapter_args - self.adapter_kwargs = adapter_kwargs - - def __getattr__(self, name): - f_locals = inspect.currentframe().f_back.f_locals - if 'self' in f_locals and f_locals['self'] is not None: - other = f_locals['self'] - caller_name = '%s.%s' % (other.__class__.__module__, other.__class__.__name__) - else: - caller_name = inspect.currentframe().f_back.f_globals['__name__'] - logger = logging.getLogger(caller_name) - - if self.adapter_class: - logger = self.adapter_class(logger, *self.adapter_args, - **self.adapter_kwargs) - - return getattr(logger, name) - - -log = AutoLogger() - - -def log_exceptions(fn): - """ A decorator designed to wrap a function and log any exception that method produces. - - The exception will still be raised after being logged. - - Also logs (at the trace level) the arguments to every call. - - Currently this is only designed for module-level functions. Not sure what happens if a method is decorated - with this (since logger is resolved from module name). - """ - - def wrapper(*args, **kwargs): - try: - a = args or [] - a = [str(x)[:255] for x in a] - kw = kwargs or {} - kw = {str(k)[:255]: str(v)[:255] for k, v in kw.items()} - log.debug('Calling %s.%s %r %r' % (fn.__module__, fn.__name__, a, kw)) - return fn(*args, **kwargs) - except Exception as e: - log.error('Error calling function %s: %s' % (fn.__name__, e)) - log.exception(e) - raise - - wrapper.__name__ = fn.__name__ - return wrapper - - -TRACE_LEVEL = 5 -logging.addLevelName(TRACE_LEVEL, "TRACE") - - -def trace(self, message, *args, **kws): - # Yes, logger takes its '*args' as 'args'. - self._log(TRACE_LEVEL, message, args, **kws) -logging.Logger.trace = trace diff --git a/sideboard/internal/connection_checker.py b/sideboard/internal/connection_checker.py deleted file mode 100644 index eeb7673..0000000 --- a/sideboard/internal/connection_checker.py +++ /dev/null @@ -1,76 +0,0 @@ -from __future__ import unicode_literals, print_function -import ssl -import socket -from contextlib import closing - -import six -from six.moves.urllib_parse import urlparse - -from sideboard.lib import services, entry_point - - -def _check(url, **ssl_params): - status = ['checking {}'.format(url)] - - try: - parsed = urlparse(url) - except Exception as e: - return status + ['failed to parse url: {!s}'.format(e)] - else: - host = parsed.hostname - port = parsed.port or (443 if parsed.scheme in ['https', 'wss'] else 80) - status.append('using hostname {} and port {}'.format(host, port)) - - try: - ip = socket.gethostbyname(host) - except Exception as e: - return status + ['failed to resolve host with DNS: {!s}'.format(e)] - else: - status.append('successfully resolved host {} to {}'.format(host, ip)) - - sock = None - try: - sock = socket.create_connection((host, port)) - except Exception as e: - return status + ['failed to establish a socket connection to {} on port {}: {!s}'.format(host, port, e)] - else: - status.append('successfully opened socket connection to {}:{}'.format(host, port)) - - # check if any of the non-version SSL options have been set - if any(val for val in ssl_params.values() if not isinstance(val, int)): - try: - wrapped = ssl.wrap_socket(sock, **ssl_params) - except Exception as e: - return status + ['failed to complete SSL handshake ({}): {!s}'.format(ssl_params, e)] - else: - status.append('succeeded at SSL handshake (without validating server cert)') - finally: - if sock: - sock.close() - - try: - with closing(socket.create_connection((host, port))) as sock: - wrapped = ssl.wrap_socket(sock, **dict(ssl_params, cert_reqs=ssl.CERT_REQUIRED)) - status.append('succeeded at validating server cert') - except Exception as e: - return status + ['failed to validate server cert ({}): {!s}'.format(ssl_params, e)] - - status.append('everything seems to work') - return status - - -def check_all(): - checks = {} - for name, jservice in services._jsonrpc.items(): - jproxy = jservice._send.im_self if six.PY2 else jservice._send.__self__ # ugly kludge to get the ServerProxy object - url = '{}://{}/'.format(jproxy.type, jproxy.host) - checks[name] = _check(url, **jproxy.ssl_opts) - return checks - - -@entry_point -def check_connections(): - for service, results in sorted(check_all().items()): - print(service) - print('-' * len(service)) - print('\n'.join(results) + '\n') diff --git a/sideboard/internal/logging.py b/sideboard/internal/logging.py deleted file mode 100644 index 20e71b8..0000000 --- a/sideboard/internal/logging.py +++ /dev/null @@ -1,46 +0,0 @@ -from __future__ import unicode_literals, absolute_import -import os -import logging.config - -from sideboard.config import config, get_config_root - - -class IndentMultilinesLogFormatter(logging.Formatter): - """ - Provide a formatter (unused by default) which adds indentation to messages - which are split across multiple lines. - """ - def format(self, record): - s = super(IndentMultilinesLogFormatter, self).format(record) - # indent all lines that start with a newline so they are easier for external log programs to parse - s = s.rstrip('\n').replace('\n', '\n ') - return s - - -def _configure_logging(): - fname = os.path.join(get_config_root(), 'logging.cfg') - if os.path.exists(fname): - logging.config.fileConfig(fname, disable_existing_loggers=True) - else: - # ConfigObj doesn't support interpolation escaping, so we manually work around it here - formatters = config['formatters'].dict() - for formatter in formatters.values(): - formatter['format'] = formatter['format'].replace('$$', '%') - formatter['datefmt'] = formatter['datefmt'].replace('$$', '%') or None - formatters['indent_multiline'] = { - '()': IndentMultilinesLogFormatter, - 'format': formatters['default']['format'] - } - logging.config.dictConfig({ - 'version': 1, - 'root': { - 'level': config['loggers']['root'], - 'handlers': config['handlers'].dict().keys() - }, - 'loggers': { - name: {'level': level} - for name, level in config['loggers'].items() if name != 'root' - }, - 'handlers': config['handlers'].dict(), - 'formatters': formatters - }) diff --git a/sideboard/jsonrpc.py b/sideboard/jsonrpc.py deleted file mode 100755 index 70b6e4d..0000000 --- a/sideboard/jsonrpc.py +++ /dev/null @@ -1,96 +0,0 @@ -from __future__ import unicode_literals -import json -import traceback - -import cherrypy - -from sideboard.lib import log, config, serializer -from sideboard.websockets import trigger_delayed_notifications - - -ERR_INVALID_RPC = -32600 -ERR_MISSING_FUNC = -32601 -ERR_INVALID_PARAMS = -32602 -ERR_FUNC_EXCEPTION = -32603 -ERR_INVALID_JSON = -32700 - - -# TODO: this is ugly, it relies on the undocumented implementation of json_out so we should probably write our own force_json_out -def json_handler(*args, **kwargs): - value = cherrypy.serving.request._json_inner_handler(*args, **kwargs) - return json.dumps(value, cls=serializer).encode('utf-8') - - -def force_json_in(): - """A version of jsontools.json_in that forces all requests to be interpreted as JSON.""" - request = cherrypy.serving.request - if not request.headers.get('Content-Length', ''): - raise cherrypy.HTTPError(411) - - if cherrypy.request.method in ('POST', 'PUT'): - body = request.body.fp.read() - try: - cherrypy.serving.request.json = json.loads(body.decode('utf-8')) - except ValueError: - raise cherrypy.HTTPError(400, 'Invalid JSON document') - -cherrypy.tools.force_json_in = cherrypy.Tool('before_request_body', force_json_in, priority=30) - - -def _make_jsonrpc_handler(services, debug=config['debug'], - precall=lambda body: None, - errback=lambda err, message: log.error(message, exc_info=True)): - @cherrypy.expose - @cherrypy.tools.force_json_in() - @cherrypy.tools.json_out(handler=json_handler) - def jsonrpc_handler(self=None): - id = None - - def error(code, message): - body = {'jsonrpc': '2.0', 'id': id, 'error': {'code': code, 'message': message}} - log.warning('returning error message: %s', body) - return body - - body = cherrypy.request.json - if not isinstance(body, dict): - return error(ERR_INVALID_JSON, 'invalid json input {!r}'.format(cherrypy.request.body)) - - log.debug('jsonrpc request body: %s', body) - - id, params = body.get('id'), body.get('params', []) - if 'method' not in body: - return error(ERR_INVALID_RPC, '"method" field required for jsonrpc request') - - method = body['method'] - if method.count('.') != 1: - return error(ERR_MISSING_FUNC, 'invalid method ' + method) - - module, function = method.split('.') - if module not in services: - return error(ERR_MISSING_FUNC, 'no module ' + module) - - service = services[module] - if not hasattr(service, function): - return error(ERR_MISSING_FUNC, 'no function ' + method) - - if not isinstance(params, (list, dict)): - return error(ERR_INVALID_PARAMS, 'invalid parameter list: {!r}'.format(params)) - - args, kwargs = (params, {}) if isinstance(params, list) else ([], params) - - precall(body) - try: - response = {'jsonrpc': '2.0', 'id': id, - 'result': getattr(service, function)(*args, **kwargs)} - log.debug('returning success message: %s', response) - return response - except Exception as e: - errback(e, 'unexpected jsonrpc error calling ' + method) - message = 'unexpected error' - if debug: - message += ': ' + traceback.format_exc() - return error(ERR_FUNC_EXCEPTION, message) - finally: - trigger_delayed_notifications() - - return jsonrpc_handler diff --git a/sideboard/lib/__init__.py b/sideboard/lib/__init__.py index 2ad5752..213e28f 100644 --- a/sideboard/lib/__init__.py +++ b/sideboard/lib/__init__.py @@ -1,27 +1,10 @@ from __future__ import unicode_literals -import six -from sideboard.internal.autolog import log -from sideboard.config import config, ConfigurationError, parse_config -from sideboard.lib._utils import is_listy, listify, serializer, cached_property, request_cached_property, class_property, entry_point, RWGuard -from sideboard.lib._cp import stopped, on_startup, on_shutdown, mainloop, ajax, renders_template, render_with_templates, restricted, all_restricted, register_authenticator -from sideboard.lib._profiler import cleanup_profiler, profile, Profiler, ProfileAggregator -from sideboard.lib._threads import DaemonTask, Caller, GenericCaller, TimeDelayQueue -from sideboard.lib._websockets import WebSocket, Model, Subscription, MultiSubscription -from sideboard.websockets import subscribes, locally_subscribes, notifies, notify, threadlocal -from sideboard.lib._services import services +from sideboard.config import parse_config, config +from sideboard.lib._utils import serializer, entry_point +import sideboard.lib._redissession +import sideboard.lib._threads -__all__ = ['log', - 'services', - 'ConfigurationError', 'parse_config', - 'is_listy', 'listify', 'serializer', 'cached_property', 'class_property', 'entry_point', - 'stopped', 'on_startup', 'on_shutdown', 'mainloop', 'ajax', 'renders_template', 'render_with_templates', - 'restricted', 'all_restricted', 'register_authenticator', - 'cleanup_profiler', 'profile', 'Profiler', 'ProfileAggregator', - 'DaemonTask', 'Caller', 'GenericCaller', 'TimeDelayQueue', - 'WebSocket', 'Model', 'Subscription', 'MultiSubscription', - 'listify', 'serializer', 'cached_property', 'request_cached_property', 'is_listy', 'entry_point', 'RWGuard', - 'threadlocal', 'subscribes', 'locally_subscribes', 'notifies', 'notify'] -if six.PY2: - __all__ = [s.encode('ascii') for s in __all__] +__all__ = ['parse_config', 'config', + 'serializer', 'entry_point'] diff --git a/sideboard/lib/_cp.py b/sideboard/lib/_cp.py deleted file mode 100644 index d409533..0000000 --- a/sideboard/lib/_cp.py +++ /dev/null @@ -1,244 +0,0 @@ -from __future__ import unicode_literals -import json -from threading import Event -from functools import wraps -from collections import defaultdict - -from six.moves.urllib_parse import quote - -import jinja2 -import cherrypy - -from sideboard.lib._redissession import RedisSession -cherrypy.lib.sessions.RedisSession = RedisSession - -import sideboard.lib -from sideboard.lib import log, config, serializer - -auth_registry = {} -_startup_registry = defaultdict(list) -_shutdown_registry = defaultdict(list) - - -def _on_startup(func, priority): - _startup_registry[priority].append(func) - return func - - -def _on_shutdown(func, priority): - _shutdown_registry[priority].append(func) - return func - - -def on_startup(func=None, priority=50): - """ - Register a function to be called when Sideboard starts. Startup functions - have a priority, and the functions are invoked in priority order, where - low-priority-numbered functions are invoked before higher numbers. - - Startup functions may be registered in one of three ways: - - 1) A function can be passed directly, e.g. - on_startup(callback_function) - on_startup(callback_function, priority=25) - - 2) This function can be used as a decorator, e.g. - @on_startup - def callback_function(): - ... - - 3) This function can be used as a decorator with a priority value, e.g. - @on_startup(priority=25) - def callback_function(): - ... - - If instead of running a function when Sideboard starts, you need to run a - function immediately after Sideboard loads your plugin, you may optionally - declare an on_load() function in your plugin's top-level __init__.py - module. If it exists, Sideboard will call on_load() immediately after - loading the plugin, before attempting to load any subsequent plugins. - - """ - if func: - return _on_startup(func, priority) - else: - return lambda func: _on_startup(func, priority) - - -def on_shutdown(func=None, priority=50): - """ - Register a function to be called when Sideboard exits. See the on_startup - function above for how this is used. - """ - if func: - return _on_shutdown(func, priority) - else: - return lambda func: _on_shutdown(func, priority) - - -def _run_startup(): - for priority, functions in sorted(_startup_registry.items()): - for func in functions: - func() - - -def _run_shutdown(): - for priority, functions in sorted(_shutdown_registry.items()): - for func in functions: - try: - func() - except Exception: - log.warning('Ignored exception during shutdown', exc_info=True) - -stopped = Event() -on_startup(stopped.clear, priority=0) -on_shutdown(stopped.set, priority=0) - -cherrypy.engine.subscribe('start', _run_startup, priority=98) -cherrypy.engine.subscribe('stop', _run_shutdown, priority=98) - - -def mainloop(): - """ - This function exists for Sideboard plugins which do not run CherryPy. It - runs all of the functions registered with sideboard.lib.on_startup and then - waits for shutdown, at which point it runs all functions registered with - sideboard.lib.on_shutdown. - """ - _run_startup() - try: - while not stopped.is_set(): - try: - stopped.wait(config['thread_wait_interval']) - except KeyboardInterrupt: - break - finally: - _run_shutdown() - - -def ajax(method): - """ - Decorator for CherryPy page handler methods which sets the Content-Type - to application/json and serializes your function's return value to json. - """ - @wraps(method) - def to_json(self, *args, **kwargs): - cherrypy.response.headers['Content-Type'] = 'application/json' - return json.dumps(method(self, *args, **kwargs), cls=sideboard.lib.serializer) - return to_json - - -def restricted(x): - """ - Decorator for CherryPy page handler methods. This can either be called - to provide an authenticator ident or called directly as a decorator, e.g. - - @restricted - def some_page(self): ... - - is equivalent to - - @restricted(sideboard.lib.config['default_authenticator']) - def some_page(self): ... - """ - def make_decorator(ident): - def decorator(func): - @cherrypy.expose - @wraps(func) - def with_checking(*args, **kwargs): - if not auth_registry[ident]['check'](): - raise cherrypy.HTTPRedirect(auth_registry[ident]['login_path']) - else: - return func(*args, **kwargs) - return with_checking - return decorator - - if hasattr(x, '__call__'): - return make_decorator(config['default_authenticator'])(x) - else: - return make_decorator(x) - - -def renders_template(method): - """ - Decorator for CherryPy page handler methods implementing default behaviors: - - if your page handler returns a string, return that un-modified - - if your page handler returns a non-jsonrpc dictionary, render a template - with that dictionary; the function my_page will render my_page.html - """ - @cherrypy.expose - @wraps(method) - def renderer(self, *args, **kwargs): - output = method(self, *args, **kwargs) - if isinstance(output, dict) and output.get('jsonrpc') != '2.0': - return self.env.get_template(method.__name__ + '.html').render(**output) - else: - return output - return renderer - - -# Lifted from Jinja2 docs. See http://jinja.pocoo.org/docs/api/#autoescaping -def _guess_autoescape(template_name): - if template_name is None or '.' not in template_name: - return False - ext = template_name.rsplit('.', 1)[1] - return ext in ('html', 'htm', 'xml') - - -class render_with_templates(object): - """ - Class decorator for CherryPy application objects which causes all of your page - handler methods which return dictionaries to render Jinja templates found in this - directory using those dictionaries. So if you have a page handler called my_page - which returns a dictionary, the template my_page.html in the template_dir - directory will be rendered with that dictionary. An "env" attribute gets added - to the class which is a Jinja environment. - - For convenience, if the optional "restricted" parameter is passed, this class is - also passed through the @all_restricted class decorator. - """ - def __init__(self, template_dir, restricted=False): - self.template_dir, self.restricted = template_dir, restricted - - def __call__(self, klass): - klass.env = jinja2.Environment(autoescape=_guess_autoescape, loader=jinja2.FileSystemLoader(self.template_dir)) - klass.env.filters['jsonify'] = lambda x: klass.env.filters['safe'](json.dumps(x, cls=serializer)) - - if self.restricted: - all_restricted(self.restricted)(klass) - - for name, func in list(klass.__dict__.items()): - if hasattr(func, '__call__'): - setattr(klass, name, renders_template(func)) - - return klass - - -class all_restricted(object): - """Invokes the @restricted decorator on all methods of a class.""" - def __init__(self, ident): - self.ident = ident - assert ident in auth_registry, '{!r} is not a recognized authenticator'.format(ident) - - def __call__(self, klass): - for name, func in list(klass.__dict__.items()): - if hasattr(func, '__call__'): - setattr(klass, name, restricted(self.ident)(func)) - return klass - - -def register_authenticator(ident, login_path, checker): - """ - Register a new authenticator, which consists of three things: - - A string ident, used to identify the authenticator in @restricted calls. - - The path to the login page we should redirect to when not authenticated. - - A function callable with no parameters which returns a truthy value if the - user is logged in and a falsey value if they are not. - """ - assert ident not in auth_registry, '{} is already a registered authenticator'.format(ident) - auth_registry[ident] = { - 'check': checker, - 'login_path': login_path - } - -register_authenticator('default', '/login', lambda: 'username' in cherrypy.session) diff --git a/sideboard/lib/_profiler.py b/sideboard/lib/_profiler.py deleted file mode 100644 index f189a92..0000000 --- a/sideboard/lib/_profiler.py +++ /dev/null @@ -1,268 +0,0 @@ -""" -Adds profiling tools and a web interface for viewing profiling results. - -The Sideboard profiler borrows heavily from the `CherryPy profiler -`_, -but with a few added features and nicer formatting. - - * Adds the ability to sort results by different columns. - * Adds the ability to cleanup profile data files. - * Uses a better naming scheme for profile data files. - * Uses `cProfile` instead of `profile` for better performance. - -Profiling data can be collected using the @profile decorator on functions and -methods. The profiling results can be viewed at http://servername/profile/. - -Good candidates for profiling are the outermost functions that generate your -web pages, usually exposed as cherrypy endpoints via @cherrypy.expose:: - - import cherrypy - from sideboard.lib import profile - - class Root(object): - @cherrypy.expose - @profile - def index(self): - # Create and return the index page - return '' - - -But any regular function can be profiled using the @profile decorator:: - - from sideboard.lib import profile - - @profile - def some_interesting_function(): - # Do some stuff - - -The following config options control how the profiler operates, see -configspec.ini for more details:: - - [cherrypy] - profiling.on = True - profiling.path = "%(root)s/data/profiler" - profiling.aggregate = False - profiling.strip_dirs = False - -""" -from __future__ import unicode_literals -import io -import os -import os.path -import cProfile -import pstats -from datetime import datetime -from functools import wraps -from glob import glob - -import cherrypy -from sideboard.lib import config, entry_point, listify - - -def _new_func_strip_path(func_name): - """ - Adds the parent module to profiler output for `__init__.py` files. - - Copied verbatim from cherrypy/lib/profiler.py. - """ - filename, line, name = func_name - if filename.endswith('__init__.py'): - return os.path.basename(filename[:-12]) + filename[-12:], line, name - return os.path.basename(filename), line, name - -pstats.func_strip_path = _new_func_strip_path - - -@entry_point -def cleanup_profiler(): - """ - Deletes all `*.prof` files in the profiler's data directory. - - This is useful when you've created tons of profile files that you're no - longer interested in. Exposed as a `sep` command:: - - $ sep cleanup_profiler - - The profiler directory is specified in the config by:: - - [cherrypy] - profiling.path = 'path/to/profile/data' - - """ - profiling_path = config['cherrypy']['profiling.path'] - for f in glob(os.path.join(profiling_path, '*.prof')): - os.remove(f) - - -def profile(func): - """ - Decorator to capture profile data from a method or function. - - If profiling is disabled then this decorator is a no-op, and the original - function is returned unmodified. Since the original function is returned, - this decorator does not incur any performance penalty if profiling is - disabled. To enable or disable profiling use the following setting in your - config:: - - [cherrypy] - profiling.on = True # Or False to disable - - Args: - func (function): The function to profile. - - Returns: - function: Either a wrapped version of `func` with profiling enabled, - or `func` itself if profiling is disabled. - - See Also: - configspec.ini - """ - if config['cherrypy']['profiling.on']: - profiling_path = config['cherrypy']['profiling.path'] - if config['cherrypy']['profiling.aggregate']: - p = ProfileAggregator(profiling_path) - else: - p = Profiler(profiling_path) - - @wraps(func) - def wrapper(*args, **kwargs): - return p.run(func, *args, **kwargs) - return wrapper - else: - return func - - -class Profiler(object): - """ - Mostly copied from cherrypy/lib/profiler.py. - - * Adds the ability to sort results by different columns. - * Adds the ability to cleanup profile data files. - * Uses a better naming scheme for profile data files. - """ - - # https://docs.python.org/3/library/profile.html#pstats.Stats.sort_stats - sort_fields = [ - ('cumulative', 'Cumulative Time'), - ('filename', 'File Name'), - ('ncalls', 'Call Count'), - ('pcalls', 'Primitive Call Count'), - ('line', 'Line Number'), - ('name', 'Function Name'), - ('nfl', 'Function/File/Line'), - ('stdname', 'Standard Name'), - ('tottime', 'Total Time')] - - def __init__(self, path=config['cherrypy']['profiling.path']): - self.path = path - if not os.path.exists(path): - os.makedirs(path) - - def new_filename(self, func): - date = datetime.now().strftime("%Y-%m-%d_%H:%M:%S.%f") - name = func.__name__ if func.__name__ else 'unknown' - return '{}_{}.prof'.format(date, name) - - def run(self, func, *args, **params): - """Dump profile data into self.path.""" - path = os.path.join(self.path, self.new_filename(func)) - prof = cProfile.Profile() - result = prof.runcall(func, *args, **params) - prof.dump_stats(path) - return result - - def statfiles(self): - """:rtype: list of available profiles. - """ - return [f for f in os.listdir(self.path) if f.endswith('.prof')] - - def stats(self, filename, sortby='cumulative'): - """:rtype stats(index): output of print_stats() for the given profile. - """ - sio = io.StringIO() - s = pstats.Stats(os.path.join(self.path, filename), stream=sio) - if config['cherrypy']['profiling.strip_dirs']: - s.strip_dirs() - s.sort_stats(sortby) - s.print_stats() - response = sio.getvalue() - sio.close() - return response - - @cherrypy.expose - def index(self): - return ''' - Sideboard Profiler - - - - - - ''' - - @cherrypy.expose - def menu(self): - yield '

Profiling Runs

' - runs = self.statfiles() - if not runs: - yield 'No profiling runs' - else: - yield '
' - runs.sort() - for run in runs: - yield '{0}' \ - '
'.format(run) - yield '


' - yield '' \ - 'Delete all profiling runs' - - @cherrypy.expose - def report(self, filename, sortby='cumulative'): - yield 'Sort by: ' - for (field, label) in Profiler.sort_fields: - if field == sortby: - yield '{} '.format(label) - else: - yield '{}' \ - ' '.format(filename, field, label) - yield '
'
-        yield self.stats(filename, sortby)
-        yield '
' - - @cherrypy.expose - def cleanup(self): - """ - Deletes all `*.prof` files in the profiler's data directory. - - To delete all profile data files hit - http://servername/profile/cleanup/. - - The profiler directory is specified by:: - - [cherrypy] - profiling.path = 'path/to/profile/data' - - See Also: - `cleanup_profiler` - """ - cleanup_profiler() - raise cherrypy.HTTPRedirect('.') - - -class ProfileAggregator(Profiler): - """ - Mostly copied from cherrypy/lib/profiler.py. - - * Uses a better naming scheme for profile data files. - """ - - def __init__(self, path=None): - super(ProfileAggregator, self).__init__(path) - self.profiler = cProfile.Profile() - - def run(self, func, *args, **params): - path = os.path.join(self.path, self.new_filename(func)) - result = self.profiler.runcall(func, *args, **params) - self.profiler.dump_stats(path) - return result diff --git a/sideboard/lib/_redissession.py b/sideboard/lib/_redissession.py index 548778d..39cb651 100644 --- a/sideboard/lib/_redissession.py +++ b/sideboard/lib/_redissession.py @@ -7,6 +7,7 @@ from cherrypy.lib.sessions import Session import redis +import cherrypy from redis import Sentinel class RedisSession(Session): @@ -85,4 +86,6 @@ def acquire_lock(self): def release_lock(self): """Release the lock on the currently-loaded session data.""" self.locks[self.prefix+self.id].release() - self.locked = False \ No newline at end of file + self.locked = False + +cherrypy.lib.sessions.RedisSession = RedisSession diff --git a/sideboard/lib/_services.py b/sideboard/lib/_services.py deleted file mode 100644 index 38b3080..0000000 --- a/sideboard/lib/_services.py +++ /dev/null @@ -1,221 +0,0 @@ -from __future__ import unicode_literals -import os -import ssl - -from rpctools.jsonrpc import ServerProxy - -from sideboard.lib import log, config, threadlocal, WebSocket - - -class _ServiceDispatcher(object): - def __init__(self, services, name): - self.services, self.name = services, name - - def __getattr__(self, method): - from sideboard.lib import is_listy - assert self.name in self.services, '{} is not registered as a service'.format(self.name) - service = self.services[self.name] - assert not is_listy(getattr(service, '__all__', None)) or method in service.__all__, 'unable to call non-whitelisted method {}.{}'.format(self.name, method) - func = service.make_caller('{}.{}'.format(self.name, method)) if isinstance(service, WebSocket) else getattr(service, method, None) - assert func and hasattr(func, '__call__') and not method.startswith('_'), 'no such method {}.{}'.format(self.name, method) - return func - - -class _JsonrpcServices(object): - def __init__(self, services): - self.services = services - - def __getattr__(self, name): - return _ServiceDispatcher(self.services, name) - - -class _Services(object): - """ - This class is used by plugins to register services, and to call services - registered by other plugins. You call services by attribute lookup, e.g. - - >>> from sideboard.lib import services - >>> services.foo.bar() - 'Hello World!' - - You may get a service which has not yet been registered; you'll only get - an exception when calling a method on the service if it doesn't exist yet; - this is to facilitate getting a namespace before the relevant plugin has - been imported by Sideboard: - - >>> foo, baz = services.foo, services.baz - >>> foo.bar() - 'Hello World!' - >>> baz.baf() - AssertionError: baz is not registered as a service - - Services may be local or websocket, but they're called in the same way. - If you know that service is remote, and you want to use Jsonrpc, you can - use the .jsonrpc attribute of this class, e.g. - - >>> services.jsonrpc.foo.bar() - 'Hello World!' - >>> foo = services.jsonrpc.foo - >>> foo.bar() - 'Hello World!' - """ - def __init__(self): - self._services, self._jsonrpc, self._websockets = {}, {}, {} - self.jsonrpc = _JsonrpcServices(self._jsonrpc) - - def register(self, service, name=None, _jsonrpc=None, _override=False): - """ - Register an object with methods (usually a module) to be exposed under - the given name. An exception is raised if you use a name already used - by another service. - - This method takes the following parameters: - - service: the object being registered; this is typically a module but - can be anything with functions (e.g. a class instance) - - name: the name of the service being registered; if omitted, this will - default to the __name__ of the service object - - _jsonrpc: this should probably never be called by plugins; Sideboard - uses this to register both WebSoket and Jsonrpc RPC clients - """ - name = name or service.__name__ - if not _jsonrpc: - assert name not in self._services, '{} has already been registered'.format(name) - self._services[name] = service - if _jsonrpc: - self._jsonrpc[name] = _jsonrpc - - def get_services(self): - """ - Returns the dictionary we use to store our registered services. This - is NOT a copy, so it is NOT safe to modify this dictionary without - copying; this is intentional because it means that once you call this - method, the dictionary which is returned will contain all known services, - even ones registered after you called this method. - """ - return self._services - - def _register_websocket(self, url=None, connect_immediately=True, **ws_kwargs): - if url not in self._websockets: - self._websockets[url] = WebSocket(url, connect_immediately=connect_immediately, **ws_kwargs) - return self._websockets[url] - - def get_websocket(self, service_name=None): - """ - Return the websocket connection to the machine that the specified service - is running on, or a websocket connection to localhost if the service is - unknown or not provided. - """ - for name, service in self._services.items(): - if name == service_name and isinstance(service, WebSocket): - return service - else: - return self._register_websocket() - - def __getattr__(self, name): - return _ServiceDispatcher(self._services, name) - -services = _Services() - - -def _rpc_opts(host, service_config=None): - """ - Sideboard uses client certs for backend service authentication. There's a - global set of config options which determine the SSL settings we pass to our - RPC libraries, but sometimes different services require client certs issued - by different CAs. In those cases, we define a config subsection of the main - [rpc_services] section to override those settings. - - This function takes a hostname and for each config option, it returns either - the hostname-specific config option if it exists, or the global config option - if it doesn't. Specifically, this returns a dict of option names/values. - - If the service_config parameter is passed, it uses that as the config section - from which to draw the hostname-specific options. Otherwise it searches - the [rpc_services] config section for Sideboard and for all Sideboard plugins - which have a "config" object defined in order to find options for that host. - """ - from sideboard.internal.imports import plugins - section = service_config - if service_config is not None: # check explicitly for None because service_config might be {} - section = service_config - else: - rpc_sections = {host: section for host, section in config['rpc_services'].items() if isinstance(section, dict)} - for plugin in plugins.values(): - plugin_config = getattr(plugin, 'config', None) - if isinstance(plugin_config, dict): - rpc_sections.update({host: section for host, section in plugin_config.get('rpc_services', {}).items() if isinstance(section, dict)}) - section = rpc_sections.get(host, {}) - - opts = {} - for setting in ['client_key', 'client_cert', 'ca', 'ssl_version']: - path = section.get(setting, config[setting]) - if path and setting != 'ssl_version': - assert os.path.exists(path), '{} config option set to path not found on the filesystem: {}'.format(setting, path) - - opts[setting] = path - return opts - - -def _ssl_opts(rpc_opts): - """ - Given a dict of config options returned by _rpc_opts, return a dict of - options which can be passed to the ssl module. - """ - ssl_opts = { - 'ca_certs': rpc_opts['ca'], - 'keyfile': rpc_opts['client_key'], - 'certfile': rpc_opts['client_cert'], - 'cert_reqs': ssl.CERT_REQUIRED if rpc_opts['ca'] else None, - 'ssl_version': getattr(ssl, rpc_opts['ssl_version']) - } - return {k: v for k, v in ssl_opts.items() if v} - - -def _ws_url(host, rpc_opts): - """ - Given a hostname and set of config options returned by _rpc_opts, return the - standard URL websocket endpoint for a Sideboard remote service. - """ - return '{protocol}://{host}/ws'.format(host=host, protocol='wss' if rpc_opts['ca'] else 'ws') - - -def _register_rpc_services(rpc_services): - """ - Sideboard has a config file, and it provides a parse_config method for its - plugins to parse their own config files. In both cases, we check for the - presence of an [rpc_services] config section, which we use to register any - services defined there with our sideboard.lib.services API. Note that this - means a server can provide information about a remote service in either the - main Sideboard config file OR the config file of any plugin. - - This function takes the [rpc_services] config section from either Sideboard - itself or one of its plugins and registers all remote services found there. - """ - for service_name, host in rpc_services.items(): - if not isinstance(host, dict): - rpc_opts = _rpc_opts(host, rpc_services.get(host, {})) - ssl_opts = _ssl_opts(rpc_opts) - - jsonrpc_url = '{protocol}://{host}/jsonrpc'.format(host=host, protocol='https' if rpc_opts['ca'] else 'http') - jproxy = ServerProxy(jsonrpc_url, ssl_opts=ssl_opts, validate_cert_hostname=bool(rpc_opts['ca'])) - jservice = getattr(jproxy, service_name) - if rpc_services.get(host, {}).get('jsonrpc_only'): - service = jservice - - services.register(service, service_name, _jsonrpc=jservice, _override=True) - -_register_rpc_services(config['rpc_services']) - - -class _SideboardCoreServices(object): - """ - Location of rpc methods we want Sideboard itself to expose in the "sideboard" - namespace. Currently this only contains "poll" but we may add more - methods, especially ones which allow you to list plugins, get version - numbers, etc. - """ - def poll(self): - """empty method which exists only to help keep WebSockets alive""" - log.debug('sideboard.poll by user %s', threadlocal.get('username')) - -services.register(_SideboardCoreServices(), 'sideboard') diff --git a/sideboard/lib/_threads.py b/sideboard/lib/_threads.py index 4d79c66..0b95fbd 100644 --- a/sideboard/lib/_threads.py +++ b/sideboard/lib/_threads.py @@ -1,205 +1,55 @@ from __future__ import unicode_literals import sys -import time -import heapq -import ctypes -import platform +import ctypes, ctypes.util +import psutil import traceback import threading -from warnings import warn -from threading import Thread, Timer, Event, Lock -import six -from six.moves.queue import Queue, Empty - -from sideboard.lib import log, config, on_startup, on_shutdown from sideboard.debugging import register_diagnostics_status_function -try: - import prctl - import psutil -except ImportError: - prctl = psutil = None # For platforms without this support. - - -def _get_linux_thread_tid(): - """ - Get the current linux thread ID as it appears in /proc/[pid]/task/[tid] - :return: Linux thread ID if available, or -1 if any errors / not on linux - """ - try: - if not platform.system().startswith('Linux'): - raise ValueError('Can only get thread id on Linux systems') - syscalls = { - 'i386': 224, # unistd_32.h: #define __NR_gettid 224 - 'x86_64': 186, # unistd_64.h: #define __NR_gettid 186 - } - syscall_num = syscalls[platform.machine()] - tid = ctypes.CDLL('libc.so.6').syscall(syscall_num) - except: - tid = -1 - return tid +# Replaces the prior prctl implementation with a direct call to pthread to change thread names +libpthread_path = ctypes.util.find_library("pthread") +pthread_setname_np = None +if libpthread_path: + libpthread = ctypes.CDLL(libpthread_path) + if hasattr(libpthread, "pthread_setname_np"): + pthread_setname_np = libpthread.pthread_setname_np + pthread_setname_np.argtypes = [ctypes.c_void_p, ctypes.c_char_p] + pthread_setname_np.restype = ctypes.c_int def _set_current_thread_ids_from(thread): # thread ID part 1: set externally visible thread name in /proc/[pid]/tasks/[tid]/comm to our internal name - if prctl and thread.name: + if pthread_setname_np and thread.name: # linux doesn't allow thread names > 15 chars, and we ideally want to see the end of the name. # attempt to shorten the name if we need to. shorter_name = thread.name if len(thread.name) < 15 else thread.name.replace('CP Server Thread', 'CPServ') - prctl.set_name(shorter_name) - - # thread ID part 2: capture linux-specific thread ID (TID) and store it with this thread object - # if TID can't be obtained or system call fails, tid will be -1 - thread.linux_tid = _get_linux_thread_tid() + if thread.ident is not None: + pthread_setname_np(thread.ident, shorter_name.encode('ASCII')) -# inject our own code at the start of every thread's start() method which sets the thread name via prctl(). +# inject our own code at the start of every thread's start() method which sets the thread name via pthread(). # Python thread names will now be shown in external system tools like 'top', '/proc', etc. def _thread_name_insert(self): _set_current_thread_ids_from(self) threading.Thread._bootstrap_inner_original(self) -if six.PY3: threading.Thread._bootstrap_inner_original = threading.Thread._bootstrap_inner threading.Thread._bootstrap_inner = _thread_name_insert -else: - threading.Thread._bootstrap_inner_original = threading.Thread._Thread__bootstrap - threading.Thread._Thread__bootstrap = _thread_name_insert # set the ID's of the main thread threading.current_thread().name = 'sideboard_main' _set_current_thread_ids_from(threading.current_thread()) -class DaemonTask(object): - def __init__(self, func, interval=None, threads=1, name=None): - self.lock = Lock() - self.threads = [] - self.stopped = Event() - self.func, self.interval, self.thread_count = func, interval, threads - self.name = name or self.func.__name__ - - on_startup(self.start) - on_shutdown(self.stop) - - @property - def running(self): - return any(t.is_alive() for t in self.threads) - - def run(self): - while not self.stopped.is_set(): - try: - self.func() - except: - log.error('unexpected error', exc_info=True) - - interval = config['thread_wait_interval'] if self.interval is None else self.interval - if interval: - self.stopped.wait(interval) - - def start(self): - with self.lock: - if not self.running: - self.stopped.clear() - del self.threads[:] - for i in range(self.thread_count): - t = Thread(target=self.run) - t.name = '{}-{}'.format(self.name, i + 1) - t.daemon = True - t.start() - self.threads.append(t) - - def stop(self): - with self.lock: - if self.running: - self.stopped.set() - for i in range(50): - self.threads[:] = [t for t in self.threads if t.is_alive()] - if self.threads: - time.sleep(0.1) - else: - break - else: - log.warning('not all daemons have been joined: %s', self.threads) - del self.threads[:] - - -class TimeDelayQueue(Queue): - def __init__(self, maxsize=0): - self.delayed = [] - Queue.__init__(self, maxsize) - self.task = DaemonTask(self._put_and_notify) - - def put(self, item, block=True, timeout=None, delay=0): - Queue.put(self, (delay, item), block, timeout) - - def _put(self, item): - delay, item = item - if delay: - if self.task.running: - heapq.heappush(self.delayed, (time.time() + delay, item)) - else: - message = 'TimeDelayQueue.put called with a delay parameter without background task having been started' - log.warning(message) - warn(message) - else: - Queue._put(self, item) - - def _put_and_notify(self): - with self.not_empty: - while self.delayed: - when, item = heapq.heappop(self.delayed) - if when <= time.time(): - Queue._put(self, item) - self.not_empty.notify() - else: - heapq.heappush(self.delayed, (when, item)) - break - - -class Caller(DaemonTask): - def __init__(self, func, interval=0, threads=1, name=None): - self.q = Queue() - DaemonTask.__init__(self, self.call, interval=interval, threads=threads, name=name or func.__name__) - self.callee = func - - def call(self): - try: - args, kwargs = self.q.get(timeout=config['thread_wait_interval']) - self.callee(*args, **kwargs) - except Empty: - pass - - def defer(self, *args, **kwargs): - self.q.put([args, kwargs]) - - -class GenericCaller(DaemonTask): - def __init__(self, interval=0, threads=1, name=None): - DaemonTask.__init__(self, self.call, interval=interval, threads=threads, name=name) - self.q = Queue() - - def call(self): - try: - func, args, kwargs = self.q.get(timeout=config['thread_wait_interval']) - func(*args, **kwargs) - except Empty: - pass - - def defer(self, func, *args, **kwargs): - self.q.put([func, args, kwargs]) - - def _get_thread_current_stacktrace(thread_stack, thread): out = [] - linux_tid = getattr(thread, 'linux_tid', -1) status = '[unknown]' - if psutil and linux_tid != -1: - status = psutil.Process(linux_tid).status() + if psutil and thread.native_id != -1: + status = psutil.Process(thread.native_id).status() out.append('\n--------------------------------------------------------------------------') out.append('# Thread name: "%s"\n# Python thread.ident: %d\n# Linux Thread PID (TID): %d\n# Run Status: %s' - % (thread.name, thread.ident, linux_tid, status)) + % (thread.name, thread.ident, thread.native_id, status)) for filename, lineno, name, line in traceback.extract_stack(thread_stack): out.append('File: "%s", line %d, in %s' % (filename, lineno, name)) if line: diff --git a/sideboard/lib/_utils.py b/sideboard/lib/_utils.py index 3f774bb..1225d0e 100644 --- a/sideboard/lib/_utils.py +++ b/sideboard/lib/_utils.py @@ -1,29 +1,6 @@ from __future__ import unicode_literals -import os import json -from functools import wraps from datetime import datetime, date -from contextlib import contextmanager -from threading import RLock, Condition, current_thread -from collections.abc import Sized, Iterable, Mapping -from collections import defaultdict - - -def is_listy(x): - """ - returns a boolean indicating whether the passed object is "listy", - which we define as a sized iterable which is not a map or string - """ - return isinstance(x, Sized) and isinstance(x, Iterable) and not isinstance(x, (Mapping, type(b''), type(''))) - - -def listify(x): - """ - returns a list version of x if x is a non-string iterable, otherwise - returns a list with x as its only element - """ - return list(x) if is_listy(x) else [x] - class serializer(json.JSONEncoder): """ @@ -72,56 +49,6 @@ def register(cls, type, preprocessor): serializer.register(set, lambda s: sorted(list(s))) -def cached_property(func): - """decorator for making readonly, memoized properties""" - pname = '_cached_{}'.format(func.__name__) - - @property - @wraps(func) - def caching(self, *args, **kwargs): - if not hasattr(self, pname): - setattr(self, pname, func(self, *args, **kwargs)) - return getattr(self, pname) - return caching - - -def request_cached_property(func): - """ - Sometimes we want a property to be cached for the duration of a request, - with concurrent requests each having their own cached version. This does - that via the threadlocal class, such that each HTTP request CherryPy serves - and each RPC request served via websocket or JSON-RPC will have its own - cached value, which is cleared and then re-generated on later requests. - """ - from sideboard.lib import threadlocal - name = func.__module__ + '.' + func.__name__ - - @property - @wraps(func) - def with_caching(self): - val = threadlocal.get(name) - if val is None: - val = func(self) - threadlocal.set(name, val) - return val - return with_caching - - -class _class_property(property): - def __get__(self, cls, owner): - return self.fget.__get__(None, owner)() - - -def class_property(cls): - """ - For whatever reason, the @property decorator isn't smart enough to recognize - classmethods and behave differently on them than on instance methods. This - property may be used to create a class-level property, useful for singletons - and other one-per-class properties. Class properties are read-only. - """ - return _class_property(classmethod(cls)) - - def entry_point(func): """ Decorator used to define entry points for command-line scripts. Sideboard @@ -151,113 +78,3 @@ def some_action(): return func _entry_points = {} - - -class RWGuard(object): - """ - This utility class provides the ability to perform read/write locking, such - that we can have any number of readers OR a single writer. We give priority - to writers, who will get the lock before any readers. - - These locks are reentrant, meaning that the same thread can acquire a read - or write lock multiple times, and will then need to release the lock the - same number of times it was acquired. A thread with an acquired read lock - cannot acquire a write lock, or vice versa. Locks can only be released by - the threads which acquired them. - - This class is named RWGuard rather than RWLock because it is not itself a - lock, e.g. it doesn't have an acquire method, it cannot be directly used as - a context manager, etc. - """ - def __init__(self): - self.lock = RLock() - self.waiting_writer_count = 0 - self.acquired_writer = defaultdict(int) - self.acquired_readers = defaultdict(int) - self.ready_for_reads = Condition(self.lock) - self.ready_for_writes = Condition(self.lock) - - @property - @contextmanager - def read_locked(self): - """ - Context manager which acquires a read lock on entrance and releases it - on exit. Any number of threads may acquire a read lock. - """ - self.acquire_for_read() - try: - yield - finally: - self.release() - - @property - @contextmanager - def write_locked(self): - """ - Context manager which acquires a write lock on entrance and releases it - on exit. Only one thread may acquire a write lock at a time. - """ - self.acquire_for_write() - try: - yield - finally: - self.release() - - def acquire_for_read(self): - """ - NOTE: consumers are encouraged to use the "read_locked" context manager - instead of this method where possible. - - This method acquires the read lock for the current thread, blocking if - necessary until there are no other threads with the write lock acquired - or waiting for the write lock to be available. - """ - tid = current_thread().ident - assert tid not in self.acquired_writer, 'Threads which have already acquired a write lock may not lock for reading' - with self.lock: - while self.acquired_writer or (self.waiting_writer_count and tid not in self.acquired_readers): - self.ready_for_reads.wait() - self.acquired_readers[tid] += 1 - - def acquire_for_write(self): - """ - NOTE: consumers are encouraged to use the "write_locked" context manager - instead of this method where possible. - - This method acquires the write lock for the current thread, blocking if - necessary until no other threads have the write lock acquired and no - thread has the read lock acquired. - """ - tid = current_thread().ident - assert tid not in self.acquired_readers, 'Threads which have already acquired a read lock may not lock for writing' - with self.lock: - while self.acquired_readers or (self.acquired_writer and tid not in self.acquired_writer): - self.waiting_writer_count += 1 - self.ready_for_writes.wait() - self.waiting_writer_count -= 1 - self.acquired_writer[tid] += 1 - - def release(self): - """ - Release the read or write lock held by the current thread. Since these - locks are reentrant, this method must be called once for each time the - lock was acquired. This method raises an exception if called by a - thread with no read or write lock acquired. - """ - tid = current_thread().ident - assert tid in self.acquired_readers or tid in self.acquired_writer, 'this thread does not hold a read or write lock' - with self.lock: - for counts in [self.acquired_readers, self.acquired_writer]: - counts[tid] -= 1 - if counts[tid] <= 0: - del counts[tid] - - wake_readers = not self.waiting_writer_count - wake_writers = self.waiting_writer_count and not self.acquired_readers - - if wake_writers: - with self.ready_for_writes: - self.ready_for_writes.notify() - elif wake_readers: - with self.ready_for_reads: - self.ready_for_reads.notify_all() diff --git a/sideboard/lib/_websockets.py b/sideboard/lib/_websockets.py deleted file mode 100644 index 4868565..0000000 --- a/sideboard/lib/_websockets.py +++ /dev/null @@ -1,638 +0,0 @@ -from __future__ import unicode_literals -import os -import sys -import json -from copy import deepcopy -from itertools import count -from threading import RLock, Event -from datetime import datetime, timedelta -from collections.abc import Mapping, MutableMapping - -import six -from ws4py.client.threadedclient import WebSocketClient - -import sideboard.lib -from sideboard.lib import log, config, stopped, on_startup, on_shutdown, DaemonTask, Caller - - -class _WebSocketClientDispatcher(WebSocketClient): - def __init__(self, dispatcher, url, ssl_opts=None): - self.connected = False - self.dispatcher = dispatcher - WebSocketClient.__init__(self, url, ssl_options=ssl_opts) - - def pre_connect(self): - pass - - def connect(self, *args, **kwargs): - self.pre_connect() - WebSocketClient.connect(self, *args, **kwargs) - self.connected = True - - def close(self, code=1000, reason=''): - try: - WebSocketClient.close(self, code=code, reason=reason) - except: - pass - try: - WebSocketClient.close_connection(self) - except: - pass - self.connected = False - - def send(self, data): - log.debug('sending %s', data) - assert self.connected, 'tried to send data on closed websocket {!r}'.format(self.url) - if isinstance(data, Mapping): - data = json.dumps(data) - return WebSocketClient.send(self, data) - - def received_message(self, message): - message = message.data if isinstance(message.data, six.text_type) else message.data.decode('utf-8') - log.debug('received %s', message) - try: - message = json.loads(message) - except: - log.debug('failed to parse incoming message', exc_info=True) - finally: - self.dispatcher.defer(message) - - -class _Subscriber(object): - def __init__(self, method, src_client, dst_client, src_ws, dest_ws): - self.method, self.src_ws, self.dest_ws, self.src_client, self.dst_client = method, src_ws, dest_ws, src_client, dst_client - - def unsubscribe(self): - self.dest_ws.unsubscribe(self.dst_client) - - def callback(self, data): - self.src_ws.send(data=data, client=self.src_client) - - def errback(self, error): - self.src_ws.send(error=error, client=self.src_client) - - def __call__(self, *args, **kwargs): - self.dest_ws.subscribe({ - 'client': self.dst_client, - 'callback': self.callback, - 'errback': self.errback - }, self.method, *args, **kwargs) - return self.src_ws.NO_RESPONSE - - def __del__(self): - self.unsubscribe() - - -class WebSocket(object): - """ - Utility class for making websocket connections. This improves on the ws4py - websocket client classes mainly by adding several features: - - automatically detecting dead connections and re-connecting - - utility methods for making synchronous rpc calls and for making - asynchronous subscription calls with callbacks - - adding locking to make sending messages thread-safe - """ - poll_method = 'sideboard.poll' - WebSocketDispatcher = _WebSocketClientDispatcher - - def __init__(self, url=None, ssl_opts=None, connect_immediately=True, max_wait=2): - self.ws = None - self.url = url or 'ws://127.0.0.1:{}/ws'.format(config['cherrypy']['server.socket_port']) - self._lock = RLock() - self._callbacks = {} - self._counter = count() - self.ssl_opts = ssl_opts - self._reconnect_attempts = 0 - self._last_poll, self._last_reconnect_attempt = None, None - self._dispatcher = Caller(self._dispatch, threads=1) - self._checker = DaemonTask(self._check, interval=1) - if connect_immediately: - self.connect(max_wait=max_wait) - - def __enter__(self): - return self - - def __exit__(self, exc_type, exc_value, traceback): - self.close() - - def preprocess(self, method, params): - """ - Each message we send has its parameters passed to this function and - the actual parameters sent are whatever this function returns. By - default this just returns the message unmodified, but plugins can - override this to add whatever logic is needed. We pass the method - name in its full "service.method" form in case the logic depends on - the service being invoked. - """ - return params - - @property - def _should_reconnect(self): - interval = min(config['ws.reconnect_interval'], 2 ** self._reconnect_attempts) - cutoff = datetime.now() - timedelta(seconds=interval) - return not self.connected and (self._reconnect_attempts == 0 or self._last_reconnect_attempt < cutoff) - - @property - def _should_poll(self): - cutoff = datetime.now() - timedelta(seconds=config['ws.poll_interval']) - return self.connected and (self._last_poll is None or self._last_poll < cutoff) - - def _check(self): - if self._should_reconnect: - self._reconnect() - if self._should_poll: - self._poll() - - def _poll(self): - assert self.ws and self.ws.connected, 'cannot poll while websocket is not connected' - try: - self.call(self.poll_method) - except: - log.warning('no poll response received from %s, closing connection, will attempt to reconnect', self.url, exc_info=True) - self.ws.close() - else: - self._last_poll = datetime.now() - - def _refire_subscriptions(self): - try: - for cb in self._callbacks.values(): - if 'client' in cb: - params = cb['paramback']() if 'paramback' in cb else cb['params'] - self._send(method=cb['method'], params=params, client=cb['client']) - except: - pass # self._send() already closes and logs on error - - def _reconnect(self): - with self._lock: - assert not self.connected, 'connection is still active' - try: - self.ws = self.WebSocketDispatcher(self._dispatcher, self.url, ssl_opts=self.ssl_opts) - self.ws.connect() - except Exception as e: - log.warning('failed to connect to %s: %s', self.url, str(e)) - self._last_reconnect_attempt = datetime.now() - self._reconnect_attempts += 1 - else: - self._reconnect_attempts = 0 - self._refire_subscriptions() - - def _next_id(self, prefix): - return '{}-{}'.format(prefix, next(self._counter)) - - def _send(self, **kwargs): - log.debug('sending %s', kwargs) - with self._lock: - assert self.connected, 'tried to send data on closed websocket {!r}'.format(self.url) - try: - return self.ws.send(kwargs) - except: - log.warning('failed to send %s on %s, closing websocket and will attempt to reconnect', kwargs, self.url) - self.ws.close() - raise - - def _dispatch(self, message): - log.debug('dispatching %s', message) - try: - assert isinstance(message, Mapping), 'incoming message is not a dictionary' - assert 'client' in message or 'callback' in message, 'no callback or client in message {}'.format(message) - id = message.get('client') or message.get('callback') - assert id in self._callbacks, 'unknown dispatchee {}'.format(id) - except AssertionError: - self.fallback(message) - else: - if 'error' in message: - self._callbacks[id]['errback'](message['error']) - else: - self._callbacks[id]['callback'](message.get('data')) - - def fallback(self, message): - """ - Handler method which is called for incoming websocket messages which - aren't valid responses to an outstanding call or subscription. By - default this just logs an error message. You can override this by - subclassing this class, or just by assigning a hander method, e.g. - - >>> ws = WebSocket() - >>> ws.fallback = some_handler_function - >>> ws.connect() - """ - _, exc, _ = sys.exc_info() - log.error('no callback registered for message %s, message ignored: %s', message, exc) - - @property - def connected(self): - """boolean indicating whether or not this connection is currently active""" - return bool(self.ws) and self.ws.connected - - def connect(self, max_wait=0): - """ - Start the background threads which connect this websocket and handle RPC - dispatching. This method is safe to call even if the websocket is already - connected. You may optionally pass a max_wait parameter if you want to - wait for up to that amount of time for the connection to go through; if - that amount of time elapses without successfully connecting, a warning - message is logged. - """ - self._checker.start() - self._dispatcher.start() - for i in range(10 * max_wait): - if not self.connected: - stopped.wait(0.1) - else: - break - else: - if max_wait: - log.warning('websocket %s not connected after %s seconds', self.url, max_wait) - - def close(self): - """ - Closes the underlying websocket connection and stops background tasks. - This method is always safe to call; exceptions will be swallowed and - logged, and calling close on an already-closed websocket is a no-op. - """ - self._checker.stop() - self._dispatcher.stop() - if self.ws: - self.ws.close() - - def subscribe(self, callback, method, *args, **kwargs): - """ - Send a websocket request which you expect to subscribe you to a channel - with a callback which will be called every time there is new data, and - return the client id which uniquely identifies this subscription. - - Callback may be either a function or a dictionary in the form - { - 'callback': , - 'errback': , # optional - 'paramback: , # optional - 'client': # optional - } - Both callback and errback take a single argument; for callback, this is - the return value of the method, for errback it is the error message - returning. If no errback is specified, we will log errors at the ERROR - level and do nothing further. - - The paramback function exists for subscriptions where we might want to - pass different parameters every time we reconnect. This might be used - for e.g. time-based parameters. This function takes no arguments and - returns the parameters which should be passed every time we connect - and fire (or re-fire) all of our subscriptions. - - The client id is automatically generated if omitted, and you should not - set this yourself unless you really know what you're doing. - - The positional and keyword arguments passed to this function will be - used as the arguments to the remote method, unless paramback is passed, - in which case that will be used to generate the params, and args/kwargs - will be ignored. - """ - client = self._next_id('client') - if isinstance(callback, Mapping): - assert 'callback' in callback, 'callback is required' - client = callback.setdefault('client', client) - self._callbacks[client] = callback - else: - self._callbacks[client] = { - 'client': client, - 'callback': callback - } - - paramback = self._callbacks[client].get('paramback') - params = self.preprocess(method, paramback() if paramback else (args or kwargs)) - self._callbacks[client].setdefault('errback', lambda result: log.error('%s(*%s, **%s) returned an error: %s', method, args, kwargs, result)) - self._callbacks[client].update({ - 'method': method, - 'params': params - }) - - try: - self._send(method=method, params=params, client=client) - except: - log.warning('initial subscription to %s at %s failed, will retry on reconnect', method, self.url) - - return client - - def unsubscribe(self, client): - """ - Cancel the websocket subscription identified by the specified client id. - This id is returned from the subscribe() method, e.g. - - >>> client = ws.subscribe(some_callback, 'foo.some_function') - >>> ws.unsubscribe(client) - """ - self._callbacks.pop(client, None) - try: - self._send(action='unsubscribe', client=client) - except: - pass - - def call(self, method, *args, **kwargs): - """ - Send a websocket rpc method call, then wait for and return the eventual - response, or raise an exception if we get back an error. This method - will raise an AssertionError after 10 seconds if no response of any - kind was received. The positional and keyword arguments to this method - are used as the arguments to the rpc function call. - """ - finished = Event() - result, error = [], [] - callback = self._next_id('callback') - self._callbacks[callback] = { - 'callback': lambda response: (result.append(response), finished.set()), - 'errback': lambda response: (error.append(response), finished.set()) - } - params = self.preprocess(method, args or kwargs) - try: - self._send(method=method, params=params, callback=callback) - except: - self._callbacks.pop(callback, None) - raise - - wait_until = datetime.now() + timedelta(seconds=config['ws.call_timeout']) - while datetime.now() < wait_until: - finished.wait(0.1) - if stopped.is_set() or result or error: - break - self._callbacks.pop(callback, None) - assert not stopped.is_set(), 'websocket closed before response was received' - assert result, error[0] if error else 'no response received for 10 seconds' - return result[0] - - def make_caller(self, method): - """ - Returns a function which calls the specified method; useful for creating - callbacks, e.g. - - >>> authenticate = ws.make_caller('auth.authenticate') - >>> authenticate('username', 'password') - True - - Sideboard supports "passthrough subscriptions", e.g. - -> a browser makes a subscription for the "foo.bar" method - -> the server has "foo" registered as a remote service - -> the server creates its own subscription to "foo.bar" on the remote - service and passes all results back to the client as they arrive - - This method implements that by checking whether it was called from a - thread with an active websocket as part of a subscription request. If - so then in addition to returning a callable, it also registers the - new subscription with the client websocket so it can be cleaned up when - the client websocket closes and/or when its subscription is canceled. - """ - client = sideboard.lib.threadlocal.get_client() - originating_ws = sideboard.lib.threadlocal.get('websocket') - if client and originating_ws: - sub = originating_ws.passthru_subscriptions.get(client) - if sub: - sub.method = method - else: - sub = _Subscriber(method=method, src_client=client, dst_client=self._next_id('client'), src_ws=originating_ws, dest_ws=self) - originating_ws.passthru_subscriptions[client] = sub - return sub - else: - return lambda *args, **kwargs: self.call(method, *args, **kwargs) - - -class Model(MutableMapping): - """ - Utility class for representing database objects found in the databases of - other Sideboard plugins. Instances of this class can have their values accessed - as either attributes or dictionary keys. - """ - _prefix = None - _unpromoted = () - _defaults = None - - def __init__(self, data, prefix=None, unpromoted=None, defaults=None): - assert prefix or self._prefix - object.__setattr__(self, '_data', deepcopy(data)) - object.__setattr__(self, '_orig_data', deepcopy(data)) - object.__setattr__(self, '_prefix', (prefix or self._prefix) + '_') - object.__setattr__(self, '_project_key', self._prefix + 'data') - object.__setattr__(self, '_unpromoted', self._unpromoted if unpromoted is None else unpromoted) - object.__setattr__(self, '_defaults', defaults or self._defaults or {}) - - @property - def query(self): - assert self.id, 'id was not set' - assert self._model, '_model was not set' - return {'_model': self._model, 'field': 'id', 'value': self.id} - - @property - def dirty(self): - return {k: v for k, v in self._data.items() if v != self._orig_data.get(k)} - - def to_dict(self): - data = deepcopy(self._data) - serialized = {k: v for k, v in data.pop(self._project_key, {}).items()} - for k in list(data.get('extra_data', {}).keys()): - if k.startswith(self._prefix): - serialized[k[len(self._prefix):]] = data['extra_data'].pop(k) - elif k in self._unpromoted: - serialized[k] = data['extra_data'].pop(k) - serialized.update(data) - return serialized - - @property - def _extra_data(self): - return self._data.setdefault('extra_data', {}) - - def _extra_data_key(self, key): - return ('' if key in self._unpromoted else self._prefix) + key - - def __len__(self): - return len(self._data) + len(self._extra_data) + len(self._data.get(self._project_key, {})) - - def __setitem__(self, key, value): - assert key != 'id' or value == self.id, 'id is not settable' - if key in self._data: - self._data[key] = value - elif self._project_key in self._data: - self._extra_data.pop(self._prefix + key, None) - self._data[self._project_key][key] = value - else: - self._extra_data[self._extra_data_key(key)] = value - - def __getitem__(self, key): - if key in self._data: - return self._data[key] - elif key in self._data.get(self._project_key, {}): - return self._data[self._project_key][key] - else: - return self._extra_data.get(self._extra_data_key(key), self._defaults.get(key)) - - def __delitem__(self, key): - if key in self._data: - del self._data[key] - elif key in self._data.get(self._project_key, {}): - del self._data[self._project_key][key] - else: - self._extra_data.pop(self._extra_data_key(key), None) - - def __iter__(self): - return iter(k for k in self.to_dict() if k != 'extra_data') - - def __repr__(self): - return repr(dict(self.items())) - - def __getattr__(self, name): - return self.__getitem__(name) - - def __setattr__(self, name, value): - return self.__setitem__(name, value) - - def __delattr__(self, name): - self.__delitem__(name) - - -class Subscription(object): - """ - Utility class for opening a websocket to a given destination, subscribing to an rpc call, - and processing the response. - - >>> logged_in_users = Subscription('admin.get_logged_in_users') - >>> logged_in_users.result # this will always be the latest return value of your rpc method - - If you want to do postprocessing on the results, you can override the "callback" method: - - >>> class UserList(Subscription): - ... def __init__(self): - ... self.usernames = [] - ... Subscription.__init__(self, 'admin.get_logged_in_users') - ... - ... def callback(self, users): - ... self.usernames = [user['username'] for user in users] - ... - >>> users = UserList() - - The above code gives you a "users" object with a "usernames" attribute; when Sideboard - starts, it opens a websocket connection to whichever remote server defines the "admin" - service (as defined in the rpc_services config section), then subscribes to the - "admin.get_logged_in_users" method and calls the "callback" method on every response. - """ - - def __init__(self, rpc_method, *args, **kwargs): - self.result = None - connect_immediately = kwargs.pop('connect_immediately', False) - self.method, self.args, self.kwargs = rpc_method, args, kwargs - self.ws = sideboard.lib.services.get_websocket(rpc_method.split('.')[0]) - on_startup(self._subscribe) - on_shutdown(self._unsubscribe) - if connect_immediately: - self.ws.connect(max_wait=2) - self._subscribe() - - def _subscribe(self): - self._client_id = self.ws.subscribe(self._callback, self.method, *self.args, **self.kwargs) - - def _unsubscribe(self): - self.ws.unsubscribe(self._client_id) - - def refresh(self): - """ - re-fire your subscription method and invoke the callback method with - the response; this will manually check for changes if you are - subscribed to a method which by design doesn't re-fire on every change - """ - assert self.ws.connected, 'cannot refresh {}: websocket not connected'.format(self.method) - self._callback(self.ws.call(self.method, *self.args, **self.kwargs)) - - def _callback(self, response_data): - self.result = response_data - self.callback(response_data) - - def callback(self, response_data): - """override this to define what to do with your rpc method return values""" - - -class MultiSubscription(object): - """ - A version of the Subscription utility class which subscribes to an arbitrary - number of remote servers and aggregates the results from each. You invoke - this similarly to Subscription class, with two main differences: - - 1) The first parameter is a list of hostnames to which we should connect. - Each hostname will have a websocket registered for it if one does not - already exist, using the standard config options under [rpc_services]. - - 2) Unlike the Subscription class, we do not support the connect_immediately - parameter. Because this class looks in the [rpc_services] config section - of every plugin to find the client cert settings, we need to wait for all - plugins to be loaded before trying to connect. - - Like the Subscription class, you can instantiate this class directly, e.g. - - >>> logged_in_users = MultiSubscription(['host1', 'host2'], 'admin.get_logged_in_users') - >>> logged_in_users.results # this will always be the latest return values of your rpc method - - The "results" attribute is a dictionary whose keys are the websocket objects - used to connect to each host, and whose values are the latest return values - from each of those websockets. Hosts for which we have not yet received a - response will have no key/value pair in the "results" dictionary. - - If you want to do postprocessing on the results, you can subclass this and - override the "callback" method, e.g. - - >>> class UserList(MultiSubscription): - ... def __init__(self): - ... self.usernames = set() - ... MultiSubscription.__init__(self, ['host1', 'host2'], 'admin.get_logged_in_users') - ... - ... def callback(self, users, ws): - ... self.usernames.update(user['username'] for user in users) - ... - >>> users = UserList() - - The above code gives you a "users" object with a "usernames" attribute; when Sideboard - starts, it opens websocket connections to 'host1' and 'host2', then subscribes to the - "admin.get_logged_in_users" method and calls the "callback" method on every response. - """ - def __init__(self, hostnames, rpc_method, *args, **kwargs): - from sideboard.lib import listify - self.hostnames, self.method, self.args, self.kwargs = listify(hostnames), rpc_method, args, kwargs - self.results, self.websockets, self._client_ids = {}, {}, {} - on_startup(self._subscribe) - on_shutdown(self._unsubscribe) - - def _websocket(self, url, ssl_opts): - from sideboard.lib import services - return services._register_websocket(url, ssl_opts=ssl_opts) - - def _subscribe(self): - from sideboard.lib._services import _ws_url, _rpc_opts, _ssl_opts - for hostname in self.hostnames: - rpc_opts = _rpc_opts(hostname) - self.websockets[hostname] = self._websocket(_ws_url(hostname, rpc_opts), _ssl_opts(rpc_opts)) - - for ws in self.websockets.values(): - self._client_ids[ws] = ws.subscribe(self._make_callback(ws), self.method, *self.args, **self.kwargs) - - def _unsubscribe(self): - for ws in self.websockets.values(): - ws.unsubscribe(self._client_ids.get(ws)) - - def _make_callback(self, ws): - return lambda result_data: self._callback(result_data, ws) - - def _callback(self, response_data, ws): - self.results[ws] = response_data - self.callback(response_data, ws) - - def callback(self, result_data, ws): - """override this to define what to do with your rpc method return values""" - - def refresh(self): - """ - Sometimes we want to manually re-fire all of our subscription methods to - get the latest data. This is useful in cases where the remote server - isn't necessarily programmed to always push the latest data as soon as - it's available, usually for performance reasons. This method allows the - client to get the latest data more often than the server is programmed - to provide it. - """ - for ws in self.websockets.values(): - try: - self._callback(self.ws.call(self.method, *self.args, **self.kwargs), ws) - except: - log.warning('failed to fetch latest data from %s on %s', self.method, ws.url) diff --git a/sideboard/lib/sa/__init__.py b/sideboard/lib/sa/__init__.py deleted file mode 100644 index dd8dce7..0000000 --- a/sideboard/lib/sa/__init__.py +++ /dev/null @@ -1,331 +0,0 @@ -from __future__ import unicode_literals -import re -import json -import uuid -import types -import inspect - -import six -import sqlalchemy -from sqlalchemy import event -from sqlalchemy.ext import declarative -from sqlalchemy.dialects import postgresql -from sqlalchemy.orm import Query, sessionmaker, configure_mappers -from sqlalchemy.orm.decl_base import _declarative_constructor -from sqlalchemy.types import TypeDecorator, String, DateTime, CHAR, Unicode - -from sideboard.lib import log, config - -__all__ = ['UUID', 'JSON', 'CoerceUTF8', 'declarative_base', 'SessionManager', - 'CrudException', 'crudable', 'crud_validation', 'text_length_validation', 'regex_validation'] - - -def _camelcase_to_underscore(value): - """ Converts camelCase string to underscore_separated (aka joined_lower). - - >>> _camelcase_to_underscore('fooBarBaz') - 'foo_bar_baz' - >>> _camelcase_to_underscore('fooBarBazXYZ') - 'foo_bar_baz_xyz' - """ - s1 = re.sub(r'(.)([A-Z][a-z]+)', r'\1_\2', value) - return re.sub(r'([a-z0-9])([A-Z])', r'\1_\2', s1).lower() - - -def _underscore_to_camelcase(value, cap_segment=None): - """ Converts underscore_separated string (aka joined_lower) into camelCase string. - - >>> _underscore_to_camelcase('foo_bar_baz') - 'FooBarBaz' - >>> _underscore_to_camelcase('foo_bar_baz', cap_segment=0) - 'FOOBarBaz' - >>> _underscore_to_camelcase('foo_bar_baz', cap_segment=1) - 'FooBARBaz' - >>> _underscore_to_camelcase('foo_bar_baz', cap_segment=1000) - 'FooBarBaz' - """ - return "".join([s.title() if idx != cap_segment else s.upper() for idx, s in enumerate(value.split('_'))]) - - -class CoerceUTF8(TypeDecorator): - """ - Safely coerce Python bytestrings to Unicode - before passing off to the database. - """ - impl = Unicode - cache_ok = True - - def process_bind_param(self, value, dialect): - if isinstance(value, type(b'')): - value = value.decode('utf-8') - return value - - -class UUID(TypeDecorator): - """ - Platform-independent UUID type. - Uses Postgresql's UUID type, otherwise uses - CHAR(32), storing as stringified hex values. - """ - impl = CHAR - cache_ok = True - - def load_dialect_impl(self, dialect): - if dialect.name == 'postgresql': - return dialect.type_descriptor(postgresql.UUID()) - else: - return dialect.type_descriptor(CHAR(32)) - - def process_bind_param(self, value, dialect): - if value is None: - return value - elif dialect.name == 'postgresql': - return str(value) - else: - if not isinstance(value, uuid.UUID): - return uuid.UUID(value).hex - else: - return value.hex - - def process_result_value(self, value, dialect): - if value is None: - return value - else: - return str(uuid.UUID(value)) - - -class JSON(TypeDecorator): - impl = String - cache_ok = True - - def __init__(self, comparator=None): - self.comparator = comparator - super(JSON, self).__init__() - - def process_bind_param(self, value, dialect): - if value is None: - return None - elif isinstance(value, six.string_types): - return value - else: - return json.dumps(value) - - def process_result_value(self, value, dialect): - if value is None: - return None - return json.loads(str(value)) - - def copy_value(self, value): - if self.mutable: - return json.loads(json.dumps(value)) - else: - return value - - def compare_values(self, x, y): - if self.comparator: - return self.comparator(x, y) - else: - return x == y - - -try: - from pytz import UTC -except ImportError: - pass -else: - class UTCDateTime(TypeDecorator): - impl = DateTime - cache_ok = True - - def process_bind_param(self, value, engine): - if value is not None: - return value.astimezone(UTC).replace(tzinfo=None) - - def process_result_value(self, value, engine): - if value is not None: - return value.replace(tzinfo=UTC) - - __all__.append('UTCDateTime') - - -def check_constraint_naming_convention(constraint, table): - """Creates a unique name for an unnamed CheckConstraint. - - The generated name is the SQL text of the CheckConstraint with - non-alphanumeric, non-underscore operators converted to text, and all - other non-alphanumeric, non-underscore substrings replaced by underscores. - - If the generated name is longer than 32 characters, a uuid5 based on the - generated name will be returned instead. - - >>> check_constraint_naming_convention(CheckConstraint('failed_logins > 3'), Table('account', MetaData())) - 'failed_logins_gt_3' - - See: http://docs.sqlalchemy.org/en/latest/core/constraints.html#configuring-constraint-naming-conventions - """ - # The text of the replacements doesn't matter, so long as it's unique - replacements = [ - ('||/', 'cr'), ('<=', 'le'), ('>=', 'ge'), ('<>', 'nq'), ('!=', 'ne'), - ('||', 'ct'), ('<<', 'ls'), ('>>', 'rs'), ('!!', 'fa'), ('|/', 'sr'), - ('@>', 'cn'), ('<@', 'cb'), ('&&', 'an'), ('<', 'lt'), ('=', 'eq'), - ('>', 'gt'), ('!', 'ex'), ('"', 'qt'), ('#', 'hs'), ('$', 'dl'), - ('%', 'pc'), ('&', 'am'), ('\'', 'ap'), ('(', 'lpr'), (')', 'rpr'), - ('*', 'as'), ('+', 'pl'), (',', 'cm'), ('-', 'da'), ('.', 'pd'), - ('/', 'sl'), (':', 'co'), (';', 'sc'), ('?', 'qn'), ('@', 'at'), - ('[', 'lbk'), ('\\', 'bs'), (']', 'rbk'), ('^', 'ca'), ('`', 'tk'), - ('{', 'lbc'), ('|', 'pi'), ('}', 'rbc'), ('~', 'td')] - - constraint_name = str(constraint.sqltext).strip() - for operator, text in replacements: - constraint_name = constraint_name.replace(operator, text) - - constraint_name = re.sub(r'[\W\s]+', '_', constraint_name) - if len(constraint_name) > 32: - constraint_name = uuid.uuid5(uuid.NAMESPACE_OID, str(constraint_name)).hex - return constraint_name - - -def declarative_base(*orig_args, **orig_kwargs): - """ - Replacement for SQLAlchemy's declarative_base, which adds these features: - 1) This is a decorator. - 2) This allows your base class to set a constructor. - 3) This provides a default constructor which automatically sets defaults - instead of waiting to do that until the object is committed. - 4) Automatically setting __tablename__ to snake-case. - 5) Automatic integration with the SessionManager class. - """ - orig_args = list(orig_args) - - def _decorate_base_class(klass): - - class Mixed(klass, CrudMixin): - def __init__(self, *args, **kwargs): - """ - Variant on SQLAlchemy model __init__ which sets default values on - initialization instead of immediately before the model is saved. - """ - if '_model' in kwargs: - assert kwargs.pop('_model') == self.__class__.__name__ - _declarative_constructor(self, *args, **kwargs) - for attr, col in self.__table__.columns.items(): - if kwargs.get(attr) is None and col.default: - self.__dict__.setdefault(attr, col.default.arg(col)) - - orig_kwargs['cls'] = Mixed - if 'name' not in orig_kwargs: - orig_kwargs['name'] = klass.__name__ - if 'constructor' not in orig_kwargs: - orig_kwargs['constructor'] = klass.__init__ if '__init__' in klass.__dict__ else Mixed.__init__ - - Mixed = declarative.declarative_base(*orig_args, **orig_kwargs) - Mixed.BaseClass = _SessionInitializer._base_classes[klass.__module__] = Mixed - Mixed.__tablename__ = declarative.declared_attr(lambda cls: _camelcase_to_underscore(cls.__name__)) - return Mixed - - is_class_decorator = not orig_kwargs and \ - len(orig_args) == 1 and \ - inspect.isclass(orig_args[0]) and \ - not isinstance(orig_args[0], sqlalchemy.engine.Connectable) - - if is_class_decorator: - return _decorate_base_class(orig_args.pop()) - else: - return _decorate_base_class - - -class _SessionInitializer(type): - _base_classes = {} - - def __new__(cls, name, bases, attrs): - SessionClass = type.__new__(cls, name, bases, attrs) - if hasattr(SessionClass, 'engine'): - if not hasattr(SessionClass, 'BaseClass'): - for module, bc in _SessionInitializer._base_classes.items(): - if module == SessionClass.__module__: - SessionClass.BaseClass = bc - break - else: - raise AssertionError('no BaseClass specified and @declarative_base was never invoked in {}'.format(SessionClass.__module__)) - if not hasattr(SessionClass, 'session_factory'): - SessionClass.session_factory = sessionmaker(bind=SessionClass.engine, autoflush=False, autocommit=False, - query_cls=SessionClass.QuerySubclass) - SessionClass.initialize_db() - SessionClass.crud = make_crud_service(SessionClass) - return SessionClass - - -@six.add_metaclass(_SessionInitializer) -class SessionManager(object): - class SessionMixin(object): - pass - - class QuerySubclass(Query): - pass - - def __init__(self): - self.session = self.session_factory() - for name, val in self.SessionMixin.__dict__.items(): - if not name.startswith('__'): - assert not hasattr(self.session, name) and hasattr(val, '__call__') - setattr(self.session, name, types.MethodType(val, self.session)) - - def __enter__(self): - return self.session - - def __exit__(self, exc_type, exc_value, traceback): - try: - if exc_type is None: - self.session.commit() - finally: - self.session.close() - - def __del__(self): - if self.session.transaction._connections: - log.error('SessionManager went out of scope without underlying connection being closed; did you forget to use it as a context manager?') - self.session.close() - - @classmethod - def initialize_db(cls, drop=False, create=True): - configure_mappers() - cls.BaseClass.metadata.bind = cls.engine - if drop: - cls.BaseClass.metadata.drop_all(cls.engine, checkfirst=True) - if create: - cls.BaseClass.metadata.create_all(cls.engine, checkfirst=True) - - @classmethod - def all_models(cls): - return cls.BaseClass.__subclasses__() # TODO: subclasses of subclasses; this needs to be recursive or something - - @classmethod - def resolve_model(cls, name): - if inspect.isclass(name) and issubclass(name, cls.BaseClass): - return name - - subclasses = {ModelClass.__name__: ModelClass for ModelClass in cls.all_models()} - permutations = [name, _underscore_to_camelcase(name), _underscore_to_camelcase(name, cap_segment=0)] - for name in permutations: - if name in subclasses: - return subclasses[name] - - if name.lower().endswith('s'): - singular = name.rstrip('sS') - if singular in subclasses: - return subclasses[singular] - - if name.lower().endswith('ies'): - singular = name[:-3] + 'y' - if singular in subclasses: - return subclasses[singular] - - for name in permutations: - if name in cls.BaseClass.metadata.tables: - return cls.BaseClass.metadata.tables[name] - - raise ValueError('Unrecognized model: {}'.format(name)) - -if six.PY2: - __all__ = [s.encode('ascii') for s in __all__] - -from sideboard.lib.sa._crud import CrudMixin, make_crud_service, crudable, CrudException, crud_validation, text_length_validation, regex_validation diff --git a/sideboard/lib/sa/_crud.py b/sideboard/lib/sa/_crud.py deleted file mode 100644 index de9ef47..0000000 --- a/sideboard/lib/sa/_crud.py +++ /dev/null @@ -1,1958 +0,0 @@ -""" -The crud module defines a number of functions for finding SQLAlchemy model objects via a query parameter and displaying a desired portion of the resulting object graph via a data specification parameter, optionally limiting the total number returned, potentially with an offset to support paging - - -QUERY PARAMETER ---------------- -The format of the query parameter needs to support logical operators and a certain amount of introspection into which model objects are involved in a give query. For this writeup, a "query" is any set of search parameters that will result in a known SQL search string capable of returning the desired model objects. Python syntax will be used to represent the expected format of the method parameters, with allowances for representing infinite nesting/lists as appropriate. Unless explicitly stated, pluralized forms like "queries" can be read as "query or queries" due to the support of one or more queries in all cases - -The comprehensive form of the query parameter is as follows: - -query = [{ - '_model': , - '_data': , - '_label': , - # Either provide OR the items after - : [[, ]*], - # used IF AND ONLY IF is not provided - 'comparison': - 'field': , - 'value': -}] - -meaning an array of one or more dictionaries (a dictionary is equivalent to an array of length 1) of queries, one for each type of SQLAlchemy model object expected to be returned - -where: -- '' - the string corresponding to the SQLAlchemy model class name which extends your @sideboard.lib.sa.declarative_base -- '' - the optional string that signifies the purpose of this query and is only used as a convenience for the consumer of the crud method. This primarily supports counts, but can used in client code to help cue the display of those results, defaults to the contents of _model -- '' - the key is one of the following logical operators (with the value being one of more queries in a list): --- and ("intersection") --- or ("union") ---- meaning that the results of the provided queries will be the corresponding intersection/union of all the results of an individual query. Imagining a Venn Diagram is useful in this instance. -- - is a dictionary identical the dictionary taken in by the query parameter EXCEPT that _model is not included -- - a comparison operator function used to find the objects that would return "True" for the provided comparison for the value in the model_field_name. Some examples are: --- 'lt' - is the field less than value? --- 'gt' - is the field greater than value? --- 'eq' - is the field equal to value? (default) --- 'ne' - is the field not equal value? --- 'le' - is the field less than or equal to value? --- 'ge' - is the field greater than or equal to value? --- 'isnull' - does the field have a null value? (does not use the query's value parameter) --- 'isnotnull' - does the field have a non null value? (does not use the query's value parameter) --- 'in' - does the field appear in the given value? (value should be an array) --- 'contains' - does the field contain this value? (would allow other characters before or after the value) --- 'like' - same as contains, but case sensitive --- 'ilike' - same as contains, case insensitive --- 'startswith' - does the field start with value? --- 'istartswith' - case insensitive startswith --- 'endswith' - does the field end with value? --- 'iendswith' - case insensitive endswith - -- - the name of the field for the provided _model at the top level. Supports dot notation, e.g.: --- making a comparison based off all of a Team's players' names would use an 'field' of 'player.name' -- - the value that the field comparison will be made against, e.g. a value of 'text' and a comparison of 'eq' will return all matching models with fields equal to 'text'. -- - specifying what parts of the results get returned, the following section covers the format the data specification parameter - - -DATA SPECIFICATION ------------------- -Where the query parameter is only used to search existing objects in the database, the data specification parameter has two separate meanings: in the 'read' function as the _data key in the query dictionary: what information is returned in the results, in the 'update' and 'create' functions, what model type will be created/updated with what values. This is encompassed in one format, so there is some amount of redundancy depending on what actions you're performing. - -The comprehensive form of the data specification parameter is as follows: - -data = [{ - '_model': , - # a non-foreign key field - '': True (or the value of the field if the data parameter is used to create or update objects) - # a foreign key field is a special case and additional forms are supported) - '': True (all readable fields of the reference model object will be read. Has no meaning if the data parameter is used to create of update objects) - '': {, , , , ] -} - -To prevent the client from always being forced to deal with entire query result, there are three parameters in place for the crud.read method to simplify only receiving the information that's desired. At a high level: - -- 'Limit' takes a positive integer 'L' and when provided, the crud.read method will return at most L results, defaults to no limit -- 'Ordering' takes a list of ordering specification dictionaries for sorting by specific fields and in a specified direction (ascending or descending), defaults to no reordering after being returned from the database -- 'Offset' takes a positive integer 'F' and when provided, the crud.read method will return at most L results, after skipping the first (based on the ordering specification) F results. - -Used with the crud.read method to only return only a subset of information, allowing the client to only receive the amount of information it's interested in. Useful in conjunction with the offset and ordering parameter to finely-tune the information received. - -The comprehensive form of the ordering parameter is as follows: - -ordering = [{ - 'dir': <'asc'/'desc'> # either in ascending (default) or descending order - 'fields': [['.]']+ -}] + - -A single string in 'fields' is equivalent to a list with the string as the only element. If no model_object name is provided, the model_field_name is interpreted as the catch-all key for all model objects. If model_field_name isn't present on a model, or no catch-all is specified, 'id' will be used - -The list of dictionaries are interpreted as being ordered in decreasing priority. An example: - -The 'offset' parameter is used with the crud.read method to only return only a subset of information, allowing the client to only receive the amount of information it's interested in. Useful in conjunction with the limit and ordering parameter to finely-tune the information received. - -Using the 4 records in the ordering example (including the ordering specification): -- a limit of 1 with an offset of 0 (the default if unspecified) would return only the John Depp Human. -- a limit of 0 (unlimited, which is the default if unspecified) and an offset of 0 would be identical to the table in the ordering-only example -- a limit of 0 and an offset of 1 would return everything except for the first result, so in this case, the last 3 results -- a limit of 2 and an offset of 1 would return the 2nd and 3rd results, so in this case, the middle 2 results -""" -from __future__ import unicode_literals -import functools -import re -import sys -import json -import uuid -import inspect -import collections -from copy import deepcopy -from collections.abc import Mapping -from collections import defaultdict -from datetime import datetime, date, time -from itertools import chain -from functools import wraps - -import six -from sqlalchemy import orm, union, select, func -from sqlalchemy.ext.associationproxy import AssociationProxy -from sqlalchemy.ext.hybrid import hybrid_property -from sqlalchemy.orm.attributes import InstrumentedAttribute -from sqlalchemy.orm.exc import NoResultFound, MultipleResultsFound -from sqlalchemy.orm.mapper import Mapper -from sqlalchemy.orm.properties import ColumnProperty, RelationshipProperty -from sqlalchemy.orm.util import class_mapper -from sqlalchemy.schema import UniqueConstraint -from sqlalchemy.sql import text, ClauseElement -from sqlalchemy.sql.expression import alias, cast, label, bindparam, and_, or_, asc, desc, literal, text, union, join -from sqlalchemy.types import Boolean, Text, Integer, String, UnicodeText, DateTime - -from sideboard.lib import log, notify, listify, threadlocal, serializer, is_listy, class_property - - -class CrudException(Exception): - pass - - -def listify_with_count(x, count=None): - x = listify(x) - if count and len(x) < count: - x.extend([None for i in range(count - len(x))]) - return x - - -def mappify(value): - if isinstance(value, six.string_types): - return {value: True} - elif isinstance(value, collections.abc.Mapping): - return value - elif isinstance(value, collections.abc.Iterable): - return {v: True for v in value} - else: - raise TypeError('unknown datatype: {}', value) - - -def generate_date_series(startDate=None, endDate=None, interval='1 month', granularity='day'): - if granularity: - granularity = '1 %s' % granularity - else: - granularity = '1 day' - - generate_series = None - if startDate: - if endDate: - # If the startDate and the endDate are defined then we use those - generate_series = func.generate_series(startDate, endDate, granularity) - elif interval: - # If the startDate and the interval are defined then we use those - generate_series = func.generate_series(startDate, - text("DATE :start_date_param_1 + INTERVAL :interval_param_1", - bindparams=[ - bindparam("start_date_param_1", startDate), - bindparam("interval_param_1", interval)]), - granularity) - else: - # If ONLY the startDate is defined then we just use that - generate_series = func.generate_series(startDate, datetime.utcnow(), granularity) - elif endDate: - if interval: - # If the endDate and the interval are defined then we use those - generate_series = func.generate_series( - text("DATE :current_date_param_1 - INTERVAL :interval_param_1", - bindparams=[ - bindparam("current_date_param_1", endDate), - bindparam("interval_param_1", interval)]), - endDate, granularity) - else: - # If ONLY the endDate is defined then we just use that - generate_series = func.generate_series( - text("DATE :current_date_param_1 - INTERVAL :interval_param_1", - bindparams=[ - bindparam("current_date_param_1", endDate), - bindparam("interval_param_1", "1 month")]), - endDate, granularity) - elif interval: - # If ONLY the interval is defined then we default to the current date - # minus the interval - generate_series = func.generate_series( - text("DATE :current_date_param_1 - INTERVAL :interval_param_1", - bindparams=[ - bindparam("current_date_param_1", datetime.utcnow()), - bindparam("interval_param_1", interval)]), - datetime.utcnow(), granularity) - else: - # If NOTHING is defined then we return the query unmodified - generate_series = func.generate_series( - text("DATE :current_date_param_1 - INTERVAL :interval_param_1", - bindparams=[ - bindparam("current_date_param_1", datetime.utcnow()), - bindparam("interval_param_1", "1 month")]), - datetime.utcnow(), granularity) - - return generate_series - - -def normalize_date_query(query, dateLabel, reportLabel, startDate=None, endDate=None, interval='1 month', granularity='day'): - series = generate_date_series(startDate, endDate, interval, granularity) - seriesQuery = select([ - series.label(dateLabel), - literal(0).label(reportLabel) - ]) - - query = union(query, seriesQuery).alias() - query = select([ - text(dateLabel), - func.max(text(reportLabel)).label(reportLabel) - ], from_obj=query).group_by(dateLabel).order_by(dateLabel) - - return query - - -def normalize_object_graph(graph): - """ - Returns a normalized object graph given a variety of different inputs. - - If graph is a string, we assume it is a single property of an object, - and return a dict with just that property set to True. - - If graph is a dict, we assume it is already a normalized graph. - - If graph is iterable (and not a string), we assume that it's simple a - list of properties, and we return a dict with those properties set to - True. - - NOTE: This function is NOT recursive. It is intended to be repeatedly - called from an external library as it traverses the object graph. We do - this for performance reasons in case the caller decides not to traverse - the entire graph. - - >>> normalize_object_graph('prop') - {u'prop': True} - - >>> normalize_object_graph(['prop_one', 'prop_two']) - {'prop_two': True, 'prop_one': True} - - >>> normalize_object_graph({'prop_one':'test_one', 'prop_two':'test_two'}) - {u'prop_two': u'test_two', u'prop_one': u'test_one'} - """ - if isinstance(graph, six.string_types): - return {graph: True} - elif isinstance(graph, dict): - return graph - elif isinstance(graph, collections.abc.Iterable): - return dict([(str(i), True) for i in graph]) - else: - return None - - -def collect_ancestor_classes(cls, terminal_cls=None, module=None): - """ - Collects all the classes in the inheritance hierarchy of the given class, - including the class itself. - - If module is an object or list, we only return classes that are in one - of the given module/modules.This will exclude base classes that come - from external libraries. - - If terminal_cls is encountered in the hierarchy, we stop ascending - the tree. - """ - if terminal_cls is None: - terminal_cls = [] - elif not isinstance(terminal_cls, (list, set, tuple)): - terminal_cls = [terminal_cls] - - if module is not None: - if not isinstance(module, (list, set, tuple)): - module = [module] - module_strings = [] - for m in module: - if isinstance(m, six.string_types): - module_strings.append(m) - else: - module_strings.append(m.__name__) - module = module_strings - - ancestors = [] - if (module is None or cls.__module__ in module) and cls not in terminal_cls: - ancestors.append(cls) - for base in cls.__bases__: - ancestors.extend(collect_ancestor_classes(base, terminal_cls, module)) - - return ancestors - - -def collect_ancestor_attributes(cls, terminal_cls=None, module=None): - """ - Collects all the attribute names of every class in the inheritance - hierarchy of the given class, including the class itself. - """ - classes = collect_ancestor_classes(cls, terminal_cls, module) - attr_names = [] - for cls in classes: - for attr_name in cls.__dict__.keys(): - attr_names.append(attr_name) - return list(set(attr_names)) - - -def constrain_date_query(query, column, startDate=None, endDate=None, interval='1 month'): - if startDate: - if endDate: - # If the startDate and the endDate are defined then we use those - query = query.where(and_(column >= startDate, column <= endDate)) - return query - elif interval: - # If the startDate and the interval are defined then we use those - query = query.where(and_( - column >= startDate, - column <= text("DATE :start_date_param_1 + INTERVAL :interval_param_1", - bindparams=[ - bindparam("start_date_param_1", startDate), - bindparam("interval_param_1", interval)]))) - return query - else: - # If ONLY the startDate is defined then we just use that - query = query.where(column >= startDate) - return query - elif endDate: - if interval: - # If the endDate and the interval are defined then we use those - query = query.where(and_( - column <= endDate, - column >= text("DATE :end_date_param_1 - INTERVAL :interval_param_1", - bindparams=[ - bindparam("end_date_param_1", endDate), - bindparam("interval_param_1", interval)]))) - return query - else: - # If ONLY the endDate is defined then we just use that - query = query.where(column <= endDate) - return query - elif interval: - # If ONLY the interval is defined then we default to the current date - # minus the interval - query = query.where(and_( - column >= text("DATE :current_date_param_1 - INTERVAL :interval_param_1", - bindparams=[ - bindparam("current_date_param_1", datetime.utcnow()), - bindparam("interval_param_1", interval)]))) - return query - else: - # If NOTHING is defined then we return the query unmodified - return query - - -def extract_sort_field(model, value): - field = None - fields = listify(value) - for f in fields: - if isinstance(f, six.string_types): - parts = f.split('.') - if len(parts) == 1 and field is None: - if not model or (model and hasattr(model, parts[0])): - field = parts[0] - elif len(parts) > 1 and model and parts[0] == model.__name__: - field = parts[1] - else: - field = f - - if field and isinstance(field, six.string_types) and model: - attr = getattr(model, field) - if (not (isinstance(attr, InstrumentedAttribute) and isinstance(attr.property, ColumnProperty)) and - not isinstance(attr, ClauseElement)): - raise ValueError('SQLAlchemy model classes may only be sorted ' - 'by columns that exist in the database. ' - 'Provided: {}.{}'.format(model.__name__, field)) - return field or 'id' - - -def normalize_sort(model, sort): - if sort and isinstance(sort, six.string_types) and (sort.lstrip()[0] == '[' or sort.lstrip()[0] == '{'): - sort = json.loads(sort) - - if isinstance(sort, six.string_types): - return [{'field': extract_sort_field(model, sort), 'dir': 'asc'}] - elif is_listy(sort): - sorters = [] - for s in sort: - sorters.extend(normalize_sort(model, s)) - return sorters - elif isinstance(sort, dict): - field = sort.get('property', sort.get('fields', sort.get('field', []))) - direction = sort.get('direction', sort.get('dir', 'asc')).lower() - return [{ - 'field': extract_sort_field(model, field), - 'dir': direction - }] - else: - return [{'field': 'id', 'dir': 'asc'}] - - -def normalize_data(data, count=1): - """ - A singular data can be a string, a list of strings, or a dict: - 'attr' - ['attr1', 'attr2'] - {'attr1':True, 'attr2':True} - - A plural data must be specified as a list of lists or a list of dicts: - [['attr1', 'attr2'], ['attr1', 'attr2']] - [{'attr1':True, 'attr2':True}, {'attr1':True, 'attr2':True}] - - Note that if data is specified as a list of strings, it is - considered to be singular. Only a list of lists or a list of - dicts is considered plural. - - Returns the plural form of data as the comprehensive form of a list of - dictionaries mapping to True, extended to count length. If a - singular data is given, the result will be padded by repeating - that value. If a plural data is given, it will be padded with - None, for example: - >>> normalize_data('attr', 1) - [{'attr': True}] - >>> normalize_data('attr', 3) - [{'attr': True}, {'attr': True}, {'attr': True}] - >>> normalize_data(['attr1', 'attr2'], 1) - [{'attr2': True, 'attr1': True}] - >>> normalize_data(['attr1', 'attr2'], 3) - [{'attr2': True, 'attr1': True}, {'attr2': True, 'attr1': True}, {'attr2': True, 'attr1': True}] - >>> normalize_data({'attr1':True, 'attr2':True}, 1) - [{'attr2': True, 'attr1': True}] - >>> normalize_data({'attr1':True, 'attr2':True}, 3) - [{'attr2': True, 'attr1': True}, {'attr2': True, 'attr1': True}, {'attr2': True, 'attr1': True}] - >>> normalize_data([['attr1', 'attr2'], ['attr1', 'attr2']], 1) - [{'attr2': True, 'attr1': True}, {'attr2': True, 'attr1': True}] - >>> normalize_data([['attr1', 'attr2'], ['attr1', 'attr2']], 4) - [{'attr2': True, 'attr1': True}, {'attr2': True, 'attr1': True}, None, None] - >>> normalize_data([{'attr1':True, 'attr2':True}, {'attr1':True, 'attr2':True}], 1) - [{'attr2': True, 'attr1': True}, {'attr2': True, 'attr1': True}] - >>> normalize_data([{'attr1':True, 'attr2':True}, {'attr1':True, 'attr2':True}], 4) - [{'attr2': True, 'attr1': True}, {'attr2': True, 'attr1': True}, None, None] - >>> normalize_data([{'attr1':True, 'attr2':True}, ['attr1', 'attr2']], 4) - [{'attr2': True, 'attr1': True}, {'attr2': True, 'attr1': True}, None, None] - """ - if not data: - return listify_with_count(None, count) - else: - if isinstance(data, six.string_types): - data = [{data: True}] - elif isinstance(data, collections.abc.Mapping): - data = [data] - elif isinstance(data, collections.abc.Iterable): - if any(isinstance(element, six.string_types) for element in data): - # this is the singular list of strings case, so wrap it and - # go from there - data = [data] - # is this a list of strings? - data = [mappify(v) for v in data] - else: - raise TypeError('unknown datatype: {}', data) - - if len(data) < count: - if len(data) == 1: - data.extend([deepcopy(data[0]) for i in range(count - len(data))]) - else: - data.extend([None for i in range(count - len(data))]) - return data - - -def normalize_query(query, top_level=True, supermodel=None): - """ - Normalizes a variety of query formats to a known standard query format. - - The comprehensive form of the query parameter is as follows: - {code:python} - query = [{ - '_model': , - '_label': Optional identifier - # Either provide OR the items after - : [[, ]*], - # used IF AND ONLY IF is not provided - 'comparison': - 'field': , - 'value': - }]+ - {code} - """ - if query is None: - raise ValueError('None passed for query parameter') - - query = listify(deepcopy(query)) - - queries = [] - for q in query: - if isinstance(q, six.string_types): - queries.append({'_model': q, '_label': q}) - elif isinstance(q, dict): - if 'distinct' in q: - if isinstance(q['distinct'], six.string_types): - q['distinct'] = [q['distinct']] - if 'groupby' in q: - if isinstance(q['groupby'], six.string_types): - q['groupby'] = [q['groupby']] - if 'and' in q or 'or' in q: - op = 'or' - if 'and' in q: - op = 'and' - if not isinstance(q[op], (list, set, tuple)): - raise ValueError('Clause must be of type list, set, or tuple not {}, given {}'.format(type(q[op]), q[op])) - q[op] = normalize_query(q[op], False, q.get('_model', supermodel)) - if len(q[op]) == 1: - q = q[op][0] - elif '_model' not in q: - # Pull the _model up from the sub clauses. Technically the - # query format requires the _model be declared in the - # clause, but we are going to be liberal in what we accept. - model = supermodel - for clause in q[op]: - if '_model' in clause: - model = clause['_model'] - break - if model is None: - raise ValueError('Clause objects must have a "_model" attribute') - q['_model'] = model - - if '_model' in q: - queries.append(q) - elif supermodel is not None: - q['_model'] = supermodel - queries.append(q) - else: - raise ValueError('Query objects must have a "_model" attribute') - else: - raise ValueError('Query objects must be either a dict or string') - return queries - - -def collect_fields(d): - if 'field' in d: - return {d['field']} - elif 'and' in d or 'or' in d: - attrs = set() - for comp in ['and', 'or']: - for subquery in d.get(comp, []): - attrs.update(collect_fields(subquery)) - return attrs - elif 'comparison' in d or 'value' in d: - return {'id'} - else: - return d.keys() - - -def get_queries(x): - queries = [] - if isinstance(x, (list, tuple)): - for e in x: - queries.extend(get_queries(e)) - elif isinstance(x, dict): - queries.append(x) - for e in x.values(): - queries.extend(get_queries(e)) - return [d for d in queries if isinstance(d.get("_model"), six.string_types)] - - -def crud_exceptions(fn): - """A decorator designed to catch exceptions from the crud api methods.""" - @wraps(fn) - def wrapped(*args, **kwargs): - try: - return fn(*args, **kwargs) - except: - a = [x for x in (args or [])] - kw = {k: v for k, v in (kwargs or {}).items()} - log.error('Error calling %s.%s %s %s'.format(fn.__module__, fn.__name__, a, kw), exc_info=True) - exc_class, exc, tb = sys.exc_info() - raise six.reraise(CrudException, CrudException(str(exc)), tb) - return wrapped - - -def make_crud_service(Session): - - class Crud(object): - @staticmethod - def crud_subscribes(func): - func = crud_exceptions(func) - - class subscriber(object): - @property - def subscribes(self): - message = threadlocal.get('message', {}) - return Crud._get_models(message.get('params')) if message else [] - - def __call__(self, *args, **kwargs): - return func(*args, **kwargs) - - return wraps(func)(subscriber()) - - @staticmethod - def crud_notifies(func, **settings): - func = crud_exceptions(func) - - class notifier(object): - def __call__(self, *args, **kwargs): - try: - return func(*args, **kwargs) - finally: - models = Crud._get_models(args, kwargs) - notify(models, trigger=func.__name__) - - return wraps(func)(notifier()) - - @classmethod - def _collect_models(cls, query): - models = set() - for d in listify(query): - try: - model = Session.resolve_model(d['_model']) - except: - log.debug('unable to resolve model %s in query %s', d.get('_model'), d) - else: - models.add(model) - for attr_name in collect_fields(d): - curr_model = model - for prop_name in attr_name.split('.'): - if hasattr(curr_model, prop_name): - prop = getattr(curr_model, prop_name) - if isinstance(prop, InstrumentedAttribute) and hasattr(prop.property, 'mapper'): - curr_model = prop.property.mapper.class_ - models.update([curr_model]) - if prop_name in d: - subquery = deepcopy(d[prop_name]) - if isinstance(subquery, (list, set, tuple)) and not filter(lambda x: isinstance(x, dict), subquery): - subquery = {i: True for i in subquery} - elif isinstance(subquery, six.string_types): - subquery = {subquery: True} - if isinstance(subquery, dict): - subquery['_model'] = curr_model.__name__ - models.update(cls._collect_models(subquery)) - else: - break - return models - - @classmethod - def _get_models(cls, *args, **kwargs): - return {model.__name__ for model in cls._collect_models(get_queries([args, kwargs]))} - - @classmethod - def _sort_query(cls, query, model, sort): - sort = normalize_sort(model, sort) - for sorter in sort: - dir = {'asc': asc, 'desc': desc}[sorter['dir']] - field = sorter['field'] - if model: - field = getattr(model, field) - if issubclass(type(field.__clause_element__().type), String): - field = func.lower(field) - query = query.order_by(dir(field)) - return query - - @classmethod - def _limit_query(cls, query, limit, offset): - if offset is not None: - query = query.offset(offset) - if limit is not None and limit != 0: - query = query.limit(limit) - return query - - # this only works in postgresql - @classmethod - def _distinct_query(cls, query, filters): - distinct_clause = filters.get('distinct', None) - if distinct_clause: - if isinstance(distinct_clause, bool): - query = query.distinct() - else: - model = Session.resolve_model(filters.get('_model')) - columns = [getattr(model, field) for field in distinct_clause] - query = query.distinct(*columns) - return query - - @classmethod - def _groupby_query(cls, query, filters): - groupby_clause = filters.get('groupby', None) - if groupby_clause: - model = Session.resolve_model(filters.get('_model')) - columns = [getattr(model, field) for field in groupby_clause] - query = query.group_by(*columns) - return query - - @classmethod - def _filter_query(cls, query, model, filters=None, limit=None, offset=None, sort=None): - if filters: - query = cls._distinct_query(query, filters) - query = cls._groupby_query(query, filters) - filters = cls._resolve_filters(filters, model) - if filters is not None: - query = query.filter(filters) - if sort: - query = cls._sort_query(query, model, sort) - query = cls._limit_query(query, limit, offset) - return query - - @classmethod - def _resolve_comparison(cls, comparison, column, value): - if isinstance(value, dict): - model_class = Session.resolve_model(value.get('_model')) - field = value.get('select', 'id') - value = select(getattr(model_class, field)).where(cls._resolve_filters(value)) - - return { - 'eq': lambda field, val: field == val, - 'ne': lambda field, val: field != val, - 'lt': lambda field, val: field < val, - 'le': lambda field, val: field <= val, - 'gt': lambda field, val: field > val, - 'ge': lambda field, val: field >= val, - 'in': lambda field, val: field.in_(val), - 'notin': lambda field, val: ~field.in_(val), - 'isnull': lambda field, val: field == None, - 'isnotnull': lambda field, val: field != None, - 'contains': lambda field, val: field.like('%'+val+'%'), - 'icontains': lambda field, val: field.ilike('%'+val+'%'), - 'like': lambda field, val: field.like('%'+val+'%'), - 'ilike': lambda field, val: field.ilike('%'+val+'%'), - 'startswith': lambda field, val: field.startswith(val), - 'endswith': lambda field, val: field.endswith(val), - 'istartswith': lambda field, val: field.ilike(val+'%'), - 'iendswith': lambda field, val: field.ilike('%'+val) - }[comparison](column, value) - - @classmethod - def _resolve_filters(cls, filters, model=None): - model = Session.resolve_model(filters.get('_model', model)) - table = class_mapper(model).persist_selectable - and_clauses = filters.get('and', None) - or_clauses = filters.get('or', None) - if and_clauses: - return and_(*[cls._resolve_filters(c, model) for c in and_clauses]) - elif or_clauses: - return or_(*[cls._resolve_filters(c, model) for c in or_clauses]) - elif 'field' in filters or 'value' in filters or 'comparison' in filters: - field = filters.get('field', 'id').split('.') - value = filters.get('value') - comparison = filters.get('comparison', 'eq') - - if len(field) == 1: - column = getattr(model, field[0]) - return cls._resolve_comparison(comparison, column, value) - elif len(field) == 2: - property = field[0] - field = field[1] - related_table = class_mapper(model).get_property(property) - related_model = related_table.argument - if isinstance(related_model, Mapper): - related_model = related_model.class_ - elif callable(related_model): - related_model = related_model() - related_field = getattr(related_model, field) - - clause = cls._resolve_comparison(comparison, related_field, value) - if getattr(related_table, 'primaryjoin', None) is not None: - clause = and_( - clause, - related_table.primaryjoin) - if getattr(related_table, 'secondaryjoin', None) is not None: - clause = and_( - clause, - related_table.secondaryjoin) - return clause - else: - property = field[0] - join_property = field[1] - field = field[2] - - join_table = class_mapper(model).get_property(property) - join_model = join_table.argument - - if isinstance(join_model, Mapper): - join_model = join_model.class_ - elif callable(join_model): - join_model = join_model() - - related_table = class_mapper(join_model).get_property(join_property) - related_model = related_table.argument - if isinstance(related_model, Mapper): - related_model = related_model.class_ - elif callable(related_model): - related_model = related_model() - related_field = getattr(related_model, field) - - clause = cls._resolve_comparison(comparison, related_field, value) - if getattr(join_table, 'primaryjoin', None) is not None: - clause = and_( - clause, - join_table.primaryjoin) - if getattr(join_table, 'secondaryjoin', None) is not None: - clause = and_( - clause, - join_table.secondaryjoin) - - if getattr(related_table, 'primaryjoin', None) is not None: - clause = and_( - clause, - related_table.primaryjoin) - if getattr(related_table, 'secondaryjoin', None) is not None: - clause = and_( - clause, - related_table.secondaryjoin) - - return clause - else: - return None - - def get_time_format_string(self): - """ - returns the python formatting string that is used to communicate datetime - objects to and from a subscription via the crud API - """ - return serializer._datetime_format - - @crud_subscribes.__func__ - def count(query): - """ - Count the model objects matching the supplied query parameters - - @param query: Specifies the model types to count. May be a string, a list - of strings, or a list of dicts with a "_model" key specified. - @return: The count of each of the supplied model types, in a list of - dicts, like so: - [{ - '_model' : 'Player', - '_label' : 'Player on a Team', - 'count' : 12 - }] - @rtype: [c{dict}] - """ - filters = normalize_query(query) - results = [] - with Session() as session: - for filter in filters: - model = Session.resolve_model(filter['_model']) - result = {'_model': filter['_model'], - '_label': filter.get('_label', filter['_model'])} - if getattr(model, '_crud_perms', {}).get('read', True): - if filter.get('groupby', False): - columns = [] - for attr in filter['groupby']: - columns.append(getattr(model, attr)) - - rows = Crud._filter_query(session.query(func.count(columns[0]), *columns), model, filter).all() - result['count'] = [] - for row in rows: - count = {'count': row[0]} - index = 1 - for attr in filter['groupby']: - count[attr] = row[index] - index += 1 - result['count'].append(count) - else: - result['count'] = Crud._filter_query(session.query(model), model, filter).count() - results.append(result) - return results - - @crud_subscribes.__func__ - def read(query, data=None, order=None, limit=None, offset=0): - """ - Get the model objects matching the supplied query parameters, - optionally setting which part of the objects are in the returned dictionary - using the supplied data parameter - - @param query: one or more queries (as c{dict} or [c{dict}]), corresponding - to the format of the query parameter described in the module-level - docstrings. This query parameter will be normalized - @param data: one or more data specification (as c{dict} or [c{dict}]), - corresponding to the format of the data specification parameter - described in the module-level docstrings. The length of the data - parameter should either be 1 which will be the spec for each query - specified, OR of length N, where N is the number of queries after - normalization. If not provided the _data parameter will be expected - in each query - @param limit: The limit parameter, when provided with positive integer "L" - at most "L" results will be returned. Defaults to no limit - @param offset: The offset parameter, when provided with positive integer - "F", at most "L" results will be returned after skipping the first "F" - results (first based on ordering) - @return: one or more data specification dictionaries with models that - match the provided queries including all readable fields without - following foreign keys (the default if no data parameter is included), - OR the key/values specified by the data specification parameter. The - number of items returned and the order in which they appear are - controlled by the limit, offset and order parameters. Represented as: - return { - total: # count of ALL matching objects, separate from - results: [c{dict}, c{dict}, ... , c{dict}] # subject to - } - """ - with Session() as session: - filters = normalize_query(query) - data = normalize_data(data, len(filters)) - if len(filters) == 1: - filter = filters[0] - model = Session.resolve_model(filter['_model']) - total = 0 - results = [] - if getattr(model, '_crud_perms', {}).get('read', True): - total = Crud._filter_query(session.query(model), model, filter).count() - results = Crud._filter_query(session.query(model), model, filter, limit, offset, order).all() - - return {'total': total, 'results': [r.crud_read(data[0]) for r in results]} - - elif len(filters) > 1: - queries = [] - count_queries = [] - queried_models = [] - sort_field_types = {} - for filter_index, filter in enumerate(filters): - model = Session.resolve_model(filter['_model']) - if getattr(model, '_crud_perms', {}).get('read', True): - queried_models.append(model) - query_fields = [model.id, cast(literal(model.__name__), Text).label("_table_name"), cast(literal(filter_index), Integer)] - for sort_index, sort in enumerate(normalize_sort(model, order)): - sort_field = getattr(model, sort['field']) - sort_field_types[sort_index] = type(sort_field.__clause_element__().type) - query_fields.append(sort_field.label('anon_sort_{}'.format(sort_index))) - queries.append(Crud._filter_query(session.query(*query_fields), model, filter)) - count_queries.append(Crud._filter_query(session.query(model.id), model, filter)) - - total = count_queries[0].union(*(count_queries[1:])).count() - query = queries[0].union(*(queries[1:])) - normalized_sort_fields = normalize_sort(None, order) - for sort_index, sort in enumerate(normalized_sort_fields): - dir = {'asc': asc, 'desc': desc}[sort['dir']] - sort_field = 'anon_sort_{}'.format(sort_index) - if issubclass(sort_field_types[sort_index], String): - sort_field = 'lower({})'.format(sort_field) - query = query.order_by(dir(sort_field)) - if normalized_sort_fields: - query = query.order_by("_table_name") - rows = Crud._limit_query(query, limit, offset).all() - - result_table = {} - result_order = {} - query_index_table = {} - for i, row in enumerate(rows): - id = str(row[0]) - model = Session.resolve_model(row[1]) - query_index = row[2] - result_table.setdefault(model, []).append(id) - result_order[id] = i - query_index_table[id] = query_index - - for model, ids in result_table.items(): - result_table[model] = session.query(model).filter(model.id.in_(ids)).all() - - ordered_results = len(result_order) * [None] - for model, instances in result_table.items(): - for instance in instances: - ordered_results[result_order[instance.id]] = instance - results = [r for r in ordered_results if r is not None] - - return {'total': total, 'results': [r.crud_read(data[query_index_table[r.id]]) for r in results]} - else: - return {'total': 0, 'results': []} - - @crud_notifies.__func__ - def create(data): - """ - Create a model object using the provided data specifications. - - @param data: one or more data specification (as c{dict} or [c{dict}]), - corresponding to the format of the data specification parameter - described in the module-level docstrings. A new object will be created - for each data specification dictionary provided. - @return: True if the objects were successfully created - """ - data = normalize_data(data) - if any('_model' not in attrs for attrs in data): - raise CrudException('_model is required to create a new item') - - created = [] - with Session() as session: - for attrs in data: - model = Session.resolve_model(attrs['_model']) - instance = model() - session.add(instance) - instance.crud_create(**attrs) - session.flush() # any items that were created should now be queryable - created.append(instance.crud_read()) - return created - - @crud_notifies.__func__ - def update(query, data): - """ - Get the model objects matching the supplied query parameters, - setting the fields of the resulting objects to the values specified in - the data specification parameter - - @param query: one of more queries (as c{dict} or [c{dict}]), corresponding - to the format of the query parameter described in the module-level - docstrings. This query parameter will be normalized - @param data: one or more data specification (as c{dict} or [c{dict}]), - corresponding to the format of the data specification parameter - described in the module-level docstrings. The length of the data - parameter should be N, where N is the number of queries after - normalization - @return: True if the objects were successfully updated - """ - filters = normalize_query(query) - data = normalize_data(data, len(filters)) - with Session() as session: - for filter, attrs in zip(filters, data): - model = Session.resolve_model(filter['_model']) - for instance in Crud._filter_query(session.query(model), model, filter): - instance.crud_update(**attrs) - # any items that were created should now be queryable - session.flush() - return True - - @crud_notifies.__func__ - def delete(query): - """ - Delete the model objects matching the supplied query parameters - - @param id: one of more queries (as c{dict} or [c{dict}]), corresponding - to the format of the query parameter described in the module-level - docstrings. This query parameter will be normalized - @return: True if the objects were successfully updated - """ - deleted = 0 - filters = normalize_query(query) - with Session() as session: - for filter in filters: - model = Session.resolve_model(filter['_model']) - if getattr(model, '_crud_perms', {}).get('can_delete', False): - to_delete = Crud._filter_query(session.query(model), model, filter) - count = to_delete.count() - assert count in [0, 1], "each query passed to crud.delete must return at most 1 item" - if count == 1: - # don't log if there wasn't actually a deletion - item_to_delete = to_delete.one() - session.delete(item_to_delete) - deleted += count - return deleted - - return Crud() - - -class memoized(object): - """ - Decorator. Caches a function's return value each time it is called. - If called later with the same arguments, the cached value is returned - (not reevaluated). - - from http://wiki.python.org/moin/PythonDecoratorLibrary#Memoize - """ - def __init__(self, func): - self.func = func - self.cache = {} - - def __call__(self, *args): - try: - return self.cache[args] - except KeyError: - value = self.func(*args) - self.cache[args] = value - return value - except TypeError: - # uncachable -- for instance, passing a list as an argument. - # Better to not cache than to blow up entirely. - return self.func(*args) - - def __repr__(self): - """Return the function's docstring.""" - return self.func.__doc__ - - def __get__(self, obj, objtype): - """Support instance methods.""" - return functools.partial(self.__call__, obj) - - -class CrudMixin(object): - extra_defaults = [] - type_casts = {uuid.UUID: str} - type_map = {} - type_map_defaults = { - int: 'int', - six.binary_type: 'string', - six.text_type: 'string', - float: 'float', - datetime: 'date', - date: 'date', - time: 'date', - bool: 'boolean', - uuid.UUID: 'string', - String: 'string', - UnicodeText: 'string', - Text: 'string', - DateTime: 'date', - Integer: 'int', - Boolean: 'boolean', - } - - # override what attribute names will show in the repr (defaults to primary keys and unique constraints) - _repr_attr_names = () - # in addition to any default attributes, also show these in the repr - _additional_repr_attr_names = () - - @classmethod - def _get_unique_constraint_column_names(cls): - """ - Utility function for getting and then caching the column names - associated with all the unique constraints for a given model object. - This assists in fetching an existing object using the value of unique - constraints in addition to the primary key of id. - """ - if not hasattr(cls, '_unique_constraint_attributes'): - cls._unique_constraint_attributes = [[column.name for column in constraint.columns] - for constraint in cls.__table__.constraints - if isinstance(constraint, UniqueConstraint)] - return cls._unique_constraint_attributes - - @classmethod - def _get_primary_key_names(cls): - if not hasattr(cls, '_pk_names'): - cls._pk_names = [column.name for column in cls.__table__.primary_key.columns] - return cls._pk_names - - @classmethod - def _create_or_fetch(cls, session, value, **backref_mapping): - """ - Fetch an existing or create a new instance of this class. Fetching uses - the values from the value positional argument (the id if available, or - if any keys that correspond to unique constraints are present). In both - cases the instance will still need to be updated using whatever new - values you want. - - @param cls: The class object we're going to fetch or create a new one of - @param session: the session object - @param value: the dictionary value to fetch with - @param backref_mapping: the backref key name and value of the "parent" - object of the object you're fetching or about to create. If the - backref value of a fetched instance is not the same as the value - of what's passed in, we will instead create a new instance. This is - because we want to prevent "stealing" an existing object in a - one-to-one relationship unless an id is explicitly passed - @return: a previously existing or new (and added to the session) model - instance - """ - assert len(backref_mapping) <= 1, 'only one backref key is allowed at this time: {}'.format(backref_mapping) - if backref_mapping: - backref_name = list(backref_mapping.keys())[0] - parent_id = backref_mapping[backref_name] - else: - backref_name, parent_id = None, None - - id = None - if isinstance(value, Mapping): - id = value.get('id', None) - elif isinstance(value, six.string_types): - id = value - - instance = None - if id is not None: - try: - instance = session.query(cls).filter(cls.id == id).first() - except: - log.error('Unable to fetch instance based on id value %s', value, exc_info=True) - raise TypeError('Invalid instance ID type for relation: {0.__name__} (value: {1})'.format(cls, value)) - elif isinstance(value, Mapping): - # if there's no id, check to see if we're provided a dictionary - # that includes all of the columns associated with a UniqueConstraint. - for column_names in cls._get_unique_constraint_column_names(): - if all((name in value and value[name]) for name in column_names): - # all those column names are provided, - # use that to query by chaining together all the necessary - # filters to construct that query - q = session.query(cls) - filter_kwargs = {name: value[name] for name in column_names} - try: - instance = q.filter_by(**filter_kwargs).one() - except NoResultFound: - continue - except MultipleResultsFound: - log.error('multiple results found for %s unique constraint: %s', cls.__name__, column_names) - raise - else: - break - else: - log.debug('unable to search using unique constraints: %s with %s', column_names, value) - - if instance and id is None and backref_mapping and getattr(instance, backref_name, None) != parent_id: - log.warning('attempting to change the owner of %s without an explicitly passed id; a new %s instance will be used instead', instance, cls.__name__) - instance = None - - if not instance: - log.debug('creating new: %s with id %s', cls.__name__, id) - if id is None: - instance = cls() - else: - instance = cls(id=id) - session.add(instance) - return instance - - @property - def _type_casts_for_to_dict(self): - if not hasattr(self, '_to_dict_type_cast_mapping'): - type_casts = CrudMixin.type_casts.copy() - type_casts.update(self.type_casts) - self._to_dict_type_cast_mapping = defaultdict(lambda: lambda x: x, type_casts) - return self._to_dict_type_cast_mapping - - @class_property - def to_dict_default_attrs(cls): - attr_names = [] - for name in collect_ancestor_attributes(cls, terminal_cls=cls.BaseClass): - if not name.startswith('_') or name in cls.extra_defaults: - attr = getattr(cls, name) - - is_column_property = isinstance(attr, InstrumentedAttribute) and isinstance(attr.property, ColumnProperty) - is_hybrid_property = isinstance(getattr(attr, 'descriptor', None), hybrid_property) - is_property = isinstance(attr, (property, InstrumentedAttribute, ClauseElement, AssociationProxy)) - is_callable = callable(attr) - - if is_column_property or not (is_hybrid_property or is_property or is_callable): - attr_names.append(name) - return attr_names - - def to_dict(self, attrs=None, validator=lambda self, name: True): - obj = {} - attrs = normalize_object_graph(attrs) - - # it's still possible for the client to blacklist this, but by default - # we're going to include them - if attrs is None or attrs.get('_model', True): - obj['_model'] = self.__class__.__name__ - if attrs is None or attrs.get('id', True): - obj['id'] = self.id - - def cast_type(value): - # ensure that certain types are cast appropriately for daily usage - # e.g. we want the result of HashedPasswords to be the string - # representation instead of the object - return self._type_casts_for_to_dict[value.__class__](value) - - if attrs is None: - for name in self.to_dict_default_attrs: - if validator(self, name): - obj[name] = cast_type(getattr(self, name)) - else: - for name in self.extra_defaults + list(attrs.keys()): - # if we're not supposed to get the attribute according to the validator, - # OR the client intentionally blacklisted it, skipped this value - if not validator(self, name) or not attrs.get(name, True): - continue - attr = getattr(self, name, None) - if isinstance(attr, self.BaseClass): - obj[name] = attr.to_dict(attrs[name], validator) - elif isinstance(attr, (list, set, tuple, frozenset)): - obj[name] = [] - for item in attr: - if isinstance(item, self.BaseClass): - obj[name].append(item.to_dict(attrs[name], validator)) - else: - obj[name].append(item) - elif callable(attr): - obj[name] = cast_type(attr()) - else: - obj[name] = cast_type(attr) - - return obj - - def from_dict(self, attrs, validator=lambda self, name, val: True): - relations = [] - # merge_relations modifies the dictionaries that are passed to it in - # order to support updates in deeply-nested object graphs. To ensure - # that we don't have dirty state between applying updates to different - # model objects, we need a fresh copy - attrs = deepcopy(attrs) - for name, value in attrs.items(): - if not name.startswith('_') and validator(self, name, value): - attr = getattr(self.__class__, name) - if isinstance(attr, InstrumentedAttribute) and isinstance(attr.property, RelationshipProperty): - relations.append((name, value)) - else: - setattr(self, name, value) - - def required(kv): - cols = list(getattr(self.__class__, kv[0]).property.local_columns) - return len(cols) != 1 or cols[0].primary_key or cols[0].nullable - relations.sort(key=required) - - for name, value in relations: - self._merge_relations(name, value, validator) - - return self - - @classmethod - @memoized - def _get_one_to_many_foreign_key_attr_name_if_applicable(cls, name): - attr = getattr(cls, name, None) - if attr is None: - return None - - remote_side = getattr(attr.property, 'remote_side', None) - if remote_side is None: - return None - - if len(remote_side) != 1: - # there's a lookup table involved here, and we're not going to handle that - return None - [remote_column] = remote_side - - if not getattr(remote_column, 'foreign_keys', set()): - # tags don't actually have foreign keys set, but they need to be treated as the same - if name == 'tags': - log.debug('special-case handling for tags, returning: %s', remote_column.name) - return remote_column.name - else: - # the implication here could be that we're the many side of a - # many to one or many to many. That hasn't been born out in testing - # but we'll log it just in case - return None - else: - # return "our" attribute name for the remote model object - return remote_column.name - - def _merge_relations(self, name, value, validator=lambda self, name, val: True): - attr = getattr(self.__class__, name) - if (not isinstance(attr, InstrumentedAttribute) or - not isinstance(attr.property, RelationshipProperty)): - return - - session = orm.Session.object_session(self) - assert session, "cannot call _merge_relations on objects not attached to a session" - - property = attr.property - relation_cls = property.mapper.class_ - - # e.g., if this a Team with many Players, and we're handling the attribute name - # "players," we want to set the team_id on all dictionary representations of those players. - backref_id_name = self._get_one_to_many_foreign_key_attr_name_if_applicable(name) - original_value = getattr(self, name) - - if is_listy(original_value): - new_insts = [] - if value is None: - value = [] - - if isinstance(value, six.string_types): - value = [value] - - for i in value: - if backref_id_name is not None and isinstance(i, dict) and not i.get(backref_id_name): - i[backref_id_name] = self.id - relation_inst = relation_cls._create_or_fetch(session, i, **{backref_id_name: self.id} if backref_id_name else {}) - if isinstance(i, dict): - relation_inst.from_dict(i, _crud_write_validator if relation_inst._sa_instance_state.identity else _crud_create_validator) - new_insts.append(relation_inst) - - relation = original_value - remove_insts = [stale_inst for stale_inst in relation if stale_inst not in new_insts] - - for stale_inst in remove_insts: - relation.remove(stale_inst) - if property.cascade.delete_orphan: - session.delete(stale_inst) - - for new_inst in new_insts: - if new_inst.id is None or new_inst not in relation: - relation.append(new_inst) - - elif isinstance(value, (collections.abc.Mapping, six.string_types)): - if backref_id_name is not None and not value.get(backref_id_name): - # if this is a dictionary, it's possible we're going to be - # creating a new thing, if so, we'll add a backref to the - # "parent" if one isn't already set - value[backref_id_name] = self.id - - relation_inst = relation_cls._create_or_fetch(session, value) - stale_inst = original_value - if stale_inst is None or stale_inst.id != relation_inst.id: - if stale_inst is not None and property.cascade.delete_orphan: - session.delete(stale_inst) - - if isinstance(value, collections.abc.Mapping): - relation_inst.from_dict(value, validator) - session.flush([relation_inst]) # we want this this to be queryable for other things - - setattr(self, name, relation_inst) - - elif value is None: - # the first branch handles the case of setting a many-to-one value - # to None. So this is for the one-to-one-mapping case - # Setting a relation to None is nullifying the relationship, which - # has potential side effects in the case of cascades, etc. - setattr(self, name, value) - stale_inst = original_value - if stale_inst is not None and property.cascade.delete_orphan: - session.delete(stale_inst) - - else: - raise TypeError('merging relations on {1} not support for values ' - 'of type: {0.__class__.__name__} ' - '(value: {0})'.format(value, name)) - - def __setattr__(self, name, value): - if name in getattr(self, '_validators', {}): - for val_dict in self._validators[name]: - if not val_dict['model_validator'](self, value): - raise ValueError('validation failed for {.__class__.__name__}' - '.{} with value {!r}: {}'.format(self, name, value, - val_dict.get('validator_message'))) - object.__setattr__(self, name, value) - - def crud_read(self, attrs=None): - return self.to_dict(attrs, validator=_crud_read_validator) - - def crud_create(self, **kwargs): - return self.from_dict(kwargs, validator=_crud_create_validator) - - def crud_update(self, **kwargs): - return self.from_dict(kwargs, validator=_crud_write_validator) - - def __repr__(self): - """ - useful string representation for logging. Reprs do NOT return unicode - on Python 2, since python decodes it using the default encoding: - http://bugs.python.org/issue5876 - """ - # if no repr attr names have been set, default to the set of all - # unique constraints. This is unordered normally, so we'll order and - # use it here - if not self._repr_attr_names: - # this flattens the unique constraint list - _unique_attrs = chain.from_iterable(self._get_unique_constraint_column_names()) - _primary_keys = self._get_primary_key_names() - - attr_names = tuple(sorted(set(chain(_unique_attrs, - _primary_keys, - self._additional_repr_attr_names)))) - else: - attr_names = self._repr_attr_names - - if not attr_names and hasattr(self, 'id'): - # there should be SOMETHING, so use id as a fallback - attr_names = ('id',) - - if attr_names: - _kwarg_list = ' '.join('%s=%s' % (name, repr(getattr(self, name, 'undefined'))) - for name in attr_names) - kwargs_output = ' %s' % _kwarg_list - else: - kwargs_output = '' - - # specifically using the string interpolation operator and the repr of - # getattr so as to avoid any "hilarious" encode errors for non-ascii - # characters - u = '<%s%s>' % (self.__class__.__name__, kwargs_output) - return u if six.PY3 else u.encode('utf-8') - - -def _crud_read_validator(self, name): - _crud_perms = getattr(self, '_crud_perms', None) - if _crud_perms is not None and not _crud_perms.get('read', True): - raise ValueError('Attempt to read non-readable model {}'.format(self.__class__.__name__)) - elif name in self.extra_defaults: - return True - elif _crud_perms is None: - return not name.startswith('_') - else: - return name in _crud_perms.get('read', {}) - - -def _crud_write_validator(self, name, value=None): - _crud_perms = getattr(self, '_crud_perms', None) - if getattr(self, name, None) == value: - return True - elif not _crud_perms or not _crud_perms.get('update', False): - raise ValueError('Attempt to update non-updateable model {}'.format(self.__class__.__name__)) - elif name not in _crud_perms.get('update', {}): - raise ValueError('Attempt to update non-updateable attribute {}.{}'.format(self.__class__.__name__, name)) - else: - return name in _crud_perms.get("update", {}) - - -def _crud_create_validator(self, name, value=None): - _crud_perms = getattr(self, '_crud_perms', {}) - if not _crud_perms or not _crud_perms.get('can_create', False): - raise ValueError('Attempt to create non-createable model {}'.format(self.__class__.__name__)) - else: - return name in _crud_perms.get("create", {}) - - -def _isdata(obj): - """ - Stolen from inspect.classify_class_attrs function, basically is the - provided object just something that we're providing at the class level. - If True, it will be assumed that this obj does not have a meaningful - __doc__ attribute and it should be provided via the data_spec - initialization argument - """ - # Classify the object. - if isinstance(obj, staticmethod): - return False - elif isinstance(obj, classmethod): - return False - elif isinstance(obj, property): - return False - elif inspect.ismethod(obj) or inspect.ismethoddescriptor(obj): - return False - else: - return True - - -class crudable(object): - """ - Convenience decorator for specifying what methods of a model object - instance can be interacted with via the CRUD API - - Intended to be used in the sa module for SQLAlchemy model classes i.e.: - @crudable( - create=True, - read=['__something'], - no_read=['password'], - update=[], - no_update=[], - delete=True, - data_spec={ - attr={ - read=True, - update=True, - desc="description" - defaultValue= - validators={ - '', - } - }) - class MyModelObject(Base): - ... - - - and the resulting object will have a class attribute of "crud_spec" holding - a dictionary of: - - {create: True/False, - read: {, }, - update: {, }, - delete: True/False, - data_spec: { - manually_specified_attr: { - desc: "description", - type: "" - read: True/False # only needed if attribute is unspecified - update": True/False - } - - attr_with_manual_description: { - desc: "description", - type: "" - } - } - - @cvar never_read: a tuple of attribute names that default to being - not readable - @cvar never_update: a tuple of attribute names that default to being - not updatable - @cvar always_create: a tuple of attribute names that default to being - always creatable - @cvar default_labels: a dict of attribute name and desired label pairs, - to simplify setting the same label for each and every instance of an - attribute name - """ - - never_read = ('metadata',) - never_update = ('id',) - always_create = ('id',) - default_labels = {'addr': 'Address'} # TODO: allow plugins to define this; Sideboard core is not the place to encode addr/Address - - def __init__(self, can_create=True, - create=None, no_create=None, - read=None, no_read=None, - update=None, no_update=None, - can_delete=True, - data_spec=None): - """ - @param can_create: if True (default), the decorated class can be - created - @type can_create: C{bool} - @param create: if provided, interpreted as the attribute names that can - be specified when the object is created in addition to the items are - updateable. If not provided (default) all attributes that can be - updated plus id are allowed to be passed to the create method - @param no_create: if provided, interpreted as the attribute names that - will not be allowed to be passed to create, taking precedence over - anything specified in the create parameter. If not provided - (default) everything allowed by the create parameter will be - acceptable. - @param read: if provided, interpreted as the attribute names that can - be read, and ONLY these names can be read. If not provided - (default) all attributes not starting with an underscore - (e.g. __str__, or _hidden) will be readable - @type read: C{collections.abc.Iterable} - @param no_read: if provided, interpreted as the attribute names that - can't be read, taking precedence over anything specified in the - read parameter. If not provided (default) everything allowed by - the read parameter will be readable - @type no_read: C{collections.abc.Iterable} - @param update: if provided, interpreted as the attribute names that can - be updated, in addition to the list of items are readable. If None - (default) default to the list of readable attributes. Pass an empty - iterable to use the default behavior listed under the read - docstring if there were attributes passed to read that you don't - want update to default to - @type update: C{collections.abc.Iterable} - @param no_update: if provided, interpreted as the attribute names that - can't be updated, taking precedence over anything specified in the - update parameter. If None (default) default to the list of - non-readable attributes. Pass an empty iterable to use the default - behavior listed under the no_read docstring if there were - attributes passed to no_read that you don't want no_update to - default to - @type no_update: C{collections.abc.Iterable} - @param can_delete: if True (default), the decorated class can be - deleted - @type can_delete: C{bool} - @param data_spec: any additional information that should be added to - the L{model.get_crud_definition}. See that function for - complete documentation, but key items are: - "desc" - Human-readable description, will default to docstrings if - available, else not be present in the final spec - "label" - a Human-readable short label to help remember the purpose - of a particular field, without going into detail. If not - specifically provided, it will not be present in the spec - "type" - the human-readable "type" for an attribute meaning that a - conversion to this type will be performed on the server. If - possible this will be determined automatically using - isinstance(), otherwise "auto" will be set: - auto (default) - no type conversion - string - C{str} - boolean - C{bool} - int - C{int} - float - C{float} - "defaultValue" - the value that is considered the default, either - because a model instance will use this default value if - unspecified, or a client should present this option as the - default for a user - "validators" - a c{dict} mapping a validator name (e.g. "max") and - the value to be used in validation (e.g. 1000, for a max value - of 1000). This is intended to support client side validation - """ - - self.can_create = can_create - self.can_delete = can_delete - if no_update is not None and create is None: - create = deepcopy(no_update) - self.read = read or [] - self.no_read = no_read or [] - self.update = update or [] - self.no_update = no_update or [x for x in self.no_read if x not in self.update] - self.create = create or [] - self.no_create = no_create or [x for x in self.no_update if x not in self.create] - - self.no_read.extend(self.never_read) - self.no_update.extend(self.never_update) - - self.data_spec = data_spec or {} - - def __call__(self, cls): - def _get_crud_perms(cls): - if getattr(cls, '_cached_crud_perms', False): - return cls._cached_crud_perms - - crud_perms = { - 'can_create': self.can_create, - 'can_delete': self.can_delete, - 'read': [], - 'update': [], - 'create': [] - } - - read = self.read - for name in collect_ancestor_attributes(cls): - if not name.startswith('_'): - attr = getattr(cls, name) - if (isinstance(attr, (InstrumentedAttribute, property, ClauseElement)) or - isinstance(attr, (int, float, bool, datetime, date, time, six.binary_type, six.text_type, uuid.UUID))): - read.append(name) - read = list(set(read)) - for name in read: - if not self.no_read or name not in self.no_read: - crud_perms['read'].append(name) - - update = self.update + deepcopy(crud_perms['read']) - update = list(set(update)) - for name in update: - if not self.no_update or name not in self.no_update: - if name in cls.__table__.columns: - crud_perms['update'].append(name) - else: - attr = getattr(cls, name) - if isinstance(attr, property) and getattr(attr, 'fset', False): - crud_perms['update'].append(name) - elif (isinstance(attr, InstrumentedAttribute) and - isinstance(attr.property, RelationshipProperty) and - attr.property.viewonly != True): - crud_perms['update'].append(name) - - create = self.create + deepcopy(crud_perms['update']) - for name in self.always_create: - create.append(name) - if name in self.no_create: - self.no_create.remove(name) - create = list(set(create)) - for name in create: - if not self.no_create or name not in self.no_create: - crud_perms['create'].append(name) - - cls._cached_crud_perms = crud_perms - return cls._cached_crud_perms - - def _get_crud_spec(cls): - if getattr(cls, '_cached_crud_spec', False): - return cls._cached_crud_spec - - crud_perms = cls._crud_perms - - field_names = list(set(crud_perms['read']) | set(crud_perms['update']) | - set(crud_perms['create']) | set(self.data_spec.keys())) - fields = {} - for name in field_names: - # json is implicitly unicode, and since this will eventually - # be serialized as json, it's convenient to have it in that - # form early - - # if using different validation decorators or in the data spec - # causes multiple spec - # kwargs to be specified, we're going to error here for - # duplicate keys in dictionaries. Since we don't want to allow - # two different expected values for maxLength being sent in a - # crud spec for example - field_validator_kwargs = { - spec_key_name: spec_value - # collect each spec_kwarg for all validators of an attribute - for crud_validator_dict in getattr(cls, '_validators', {}).get(name, []) - for spec_key_name, spec_value in crud_validator_dict.get('spec_kwargs', {}).items() - } - - if field_validator_kwargs: - self.data_spec.setdefault(name, {}) - # manually specified crud validator keyword arguments - # overwrite the decorator-supplied keyword arguments - field_validator_kwargs.update(self.data_spec[name].get('validators', {})) - self.data_spec[name]['validators'] = field_validator_kwargs - - name = six.text_type(name) - field = deepcopy(self.data_spec.get(name, {})) - field['name'] = name - try: - attr = getattr(cls, name) - except AttributeError: - # if the object doesn't have the attribute, AND it's in the field - # list, that means we're assuming it was manually specified in the - # data_spec argument - fields[name] = field - continue - - field['read'] = name in crud_perms['read'] - field['update'] = name in crud_perms['update'] - field['create'] = name in crud_perms['create'] - - if field['read'] or field['update'] or field['create']: - fields[name] = field - elif name in fields: - del fields[name] - continue - - if 'desc' not in field and not _isdata(attr): - # no des specified, and there's a relevant docstring, so use it - - # if there's 2 consecutive newlines, assume that there's a - # separator in the docstring and that the top part only - # is the description, if there's not, use the whole thing. - # Either way, replace newlines with spaces since docstrings often - # break the same sentence over new lines due to space - doc = inspect.getdoc(attr) - if doc: - doc = doc.partition('\n\n')[0].replace('\n', ' ').strip() - field['desc'] = doc - - if 'type' not in field: - if isinstance(attr, InstrumentedAttribute) and isinstance(attr.property, ColumnProperty): - field['type'] = cls._type_map.get(type(attr.property.columns[0].type), 'auto') - field_default = getattr(attr.property.columns[0], 'default', None) - # only put the default here if it exists, and it's not an automatic thing like "time.utcnow()" - if field_default is not None and field['type'] != 'auto' and not isinstance(field_default.arg, (collections.abc.Callable, property)): - field['defaultValue'] = field_default.arg - elif hasattr(attr, "default"): - field['defaultValue'] = attr.default - else: - field['type'] = cls._type_map.get(type(attr), 'auto') - # only set a default if this isn't a property or some other kind of "constructed attribute" - if field['type'] != 'auto' and not isinstance(attr, (collections.abc.Callable, property)): - field['defaultValue'] = attr - if isinstance(attr, InstrumentedAttribute) and isinstance(attr.property, RelationshipProperty): - field['_model'] = attr.property.mapper.class_.__name__ - - crud_spec = {'fields': fields} - cls._cached_crud_spec = crud_spec - return cls._cached_crud_spec - - def _type_map(cls): - return dict(cls.type_map_defaults, **cls.type_map) - - cls._type_map = class_property(_type_map) - cls._crud_spec = class_property(_get_crud_spec) - cls._crud_perms = class_property(_get_crud_perms) - return cls - - -class crud_validation(object): - """ - Base class for adding validators to a model, supporting adding to the crud - spec, or to the save action - """ - def __init__(self, attribute_name, model_validator, validator_message, **spec_kwargs): - """ - @param attribute_name: the name of the attribute to set this validator - for - @param model_validator: the c{collections.Callable) that will accept - the value of the attribute and return False or None if invalid, - True if the value is valid. This is used on setting the attribute - name with the python instance - @param validator_message: message to print if the model validation fails - @param spec_kwargs: the key/value pairs that should be added to the - the crud spec for this attribute name. This generally supports - making the same sorts of validations in a client (e.g. javascript) - """ - self.attribute_name = attribute_name - self.model_validator = model_validator - self.validator_message = validator_message - self.spec_kwargs = spec_kwargs - - def __call__(self, cls): - if not hasattr(cls, '_validators'): - cls._validators = {} - else: - # in case we subclass something with a _validators attribute - cls._validators = deepcopy(cls._validators) - - cls._validators.setdefault(self.attribute_name, []).append({ - 'model_validator': self.model_validator, - 'validator_message': self.validator_message, - 'spec_kwargs': self.spec_kwargs - }) - return cls - - -class text_length_validation(crud_validation): - def __init__(self, attribute_name, min_length=None, max_length=None, - min_text='The minimum length of this field is {0}.', - max_text='The maximum length of this field is {0}.', - allow_none=True): - - def model_validator(instance, text): - if not text: - return allow_none - text_length = len(six.text_type(text)) - return all([min_length is None or text_length >= min_length, - max_length is None or text_length <= max_length]) - - kwargs = {} - if min_length is not None: - kwargs['minLength'] = min_length - if max_text is not None: - kwargs['minLengthText'] = min_text - if max_length is not None: - kwargs['maxLength'] = max_length - if max_text is not None: - kwargs['maxLengthText'] = max_text - - message = 'Length of value should be between {} and {} (inclusive; None means no min/max).'.format(min_length, max_length) - crud_validation.__init__(self, attribute_name, model_validator, message, **kwargs) - - -class regex_validation(crud_validation): - def __init__(self, attribute_name, regex, message): - - def regex_validator(instance, text): - # if the field isn't nullable, that will trigger an error later at the sqla level, - # but since None can't be passed to a re.search we want to pass this validation check - if text is None: - return True - - # we don't want to actually send across the match object if it did match, - # so leverage the fact that failing searches or matches return None types - return re.search(regex, text) is not None - - crud_validation.__init__(self, attribute_name, regex_validator, message, - regexText=message, regexString=regex) diff --git a/sideboard/run_debug_server.py b/sideboard/run_debug_server.py deleted file mode 100644 index 9f80019..0000000 --- a/sideboard/run_debug_server.py +++ /dev/null @@ -1,10 +0,0 @@ -from __future__ import unicode_literals -from sideboard.debugging import debugger_helpers_all_init - -import cherrypy - -if __name__ == '__main__': - debugger_helpers_all_init() - - cherrypy.engine.start() - cherrypy.engine.block() diff --git a/sideboard/run_mainloop.py b/sideboard/run_mainloop.py deleted file mode 100644 index 2b3b59d..0000000 --- a/sideboard/run_mainloop.py +++ /dev/null @@ -1,30 +0,0 @@ -from __future__ import unicode_literals -import os -import argparse - -from sideboard.lib import mainloop, entry_point, log - -parser = argparse.ArgumentParser(description='Run Sideboard as a daemon without starting CherryPy') -parser.add_argument('--pidfile', required=True, help='absolute path of file where process pid will be stored') - - -@entry_point -def mainloop_daemon(): - log.info('starting Sideboard daemon process') - args = parser.parse_args() - if os.fork() == 0: - pid = os.fork() - if pid == 0: - mainloop() - else: - log.debug('writing pid (%s) to pidfile (%s)', pid, args.pidfile) - try: - with open(args.pidfile, 'w') as f: - f.write('{}'.format(pid)) - except: - log.error('unexpected error writing pid (%s) to pidfile (%s)', pid, args.pidfile, exc_info=True) - - -@entry_point -def mainloop_foreground(): - mainloop() diff --git a/sideboard/server.py b/sideboard/server.py index 4606020..c89fc45 100755 --- a/sideboard/server.py +++ b/sideboard/server.py @@ -1,26 +1,14 @@ from __future__ import unicode_literals -import os -import sys - -import six import cherrypy -from sideboard.lib import config, threadlocal - - -def reset_threadlocal(): - threadlocal.reset(**{field: cherrypy.session.get(field) for field in config['ws.session_fields']}) - -cherrypy.tools.reset_threadlocal = cherrypy.Tool('before_handler', reset_threadlocal, priority=51) +from sideboard.lib import config cherrypy_config = {} for setting, value in config['cherrypy'].items(): - if isinstance(value, six.string_types): + if isinstance(value, str): if value.isdigit(): value = int(value) elif value.lower() in ['true', 'false']: value = value.lower() == 'true' - elif six.PY2: - value = value.encode('utf-8') cherrypy_config[setting] = value cherrypy.config.update(cherrypy_config) diff --git a/sideboard/static/angular/sideboard.js b/sideboard/static/angular/sideboard.js deleted file mode 100644 index e67fd95..0000000 --- a/sideboard/static/angular/sideboard.js +++ /dev/null @@ -1,284 +0,0 @@ - -angular.module('sideboard', []) - .factory('WebSocketService', function ($q, $log, $window, $timeout, $rootScope) { - var self = { - WS_URL: ($window.location.protocol === 'https:' ? 'wss' : 'ws') + '://' + $window.location.host + '/ws', - - CONNECTING: WebSocket.CONNECTING, - OPEN: WebSocket.OPEN, - CLOSING: WebSocket.CLOSING, - CLOSED: WebSocket.CLOSED, - - POLL_TIMEOUT: 3000, - POLL_INTERVAL: 30000, - CALL_TIMEOUT: 10000, - - currReconnectWait: 1000, - MIN_RECONNECT_WAIT: 1000, - MAX_RECONNECT_WAIT: 30000, - - requests: {}, - - currId: 1, - nextId: function () { - return self.currId++; - }, - - objectify: function (x) { - return typeof(x) === 'string' ? {client: x} : - angular.isObject(x) && !angular.isArray(x) ? x : {}; - }, - - removeIgnoredField: function (request, field) { - if (request[field]) { - $log.warn('ignoring "' + field + '" field in WebSocket RPC request'); - } - delete request[field]; - }, - - normalizeRequest: function (request, opts) { - opts = opts || {}; - request = angular.extend({ - error: opts.error || angular.identity, - callback: opts.callback || angular.identity - }, self.objectify(request)); - if (opts.single) { - self.removeIgnoredField(request, 'client'); - request.callbackId = request.callbackId || ('callback-' + self.nextId()); - } else { - self.removeIgnoredField(request, 'callbackId'); - request.client = request.client || ('client-' + self.nextId()); - } - return request; - }, - - getStatus: function() { - if (self.ws) { - return self.ws.readyState; - } else { - return self.CLOSED; - } - }, - getStatusString: function() { - return self.isConnecting() ? 'CONNECTING' : - self.isOpen() ? 'OPEN' : - self.isClosing() ? 'CLOSING' : 'CLOSED'; - }, - isOpen: function () { return self.getStatus() === self.OPEN; }, - isConnecting: function () { return self.getStatus() === self.CONNECTING; }, - isClosing: function () { return self.getStatus() === self.CLOSING; }, - isClosed: function () { return self.getStatus() === self.CLOSED; }, - - onNext: function (eventName, callback) { - var un = $rootScope.$on('WebSocketService.' + eventName, function () { - try { - callback(); - } catch(ex) { - $log.error('error invoking', eventName, 'callback', ex); - } - un(); - }); - }, - - poll: function () { - self.call({ - method: 'sideboard.poll', - timeout: self.POLL_TIMEOUT - }).then(self.schedulePoll, function () { - $log.error('closing websocket due to poll failure; will attempt to reconnect'); - self.close(1002, 'poll failed'); - self.connect(); - }); - }, - schedulePoll: function () { - self.stopPolling(); - self._poller = $timeout(self.poll, self.POLL_INTERVAL); - }, - stopPolling: function () { - $timeout.cancel(self._poller); - }, - - _connect: function () { - self.ws = new WebSocket(self.WS_URL); - self.ws.onopen = self.onOpen; - self.ws.onclose = self.onClose; - self.ws.onerror = self.onError; - self.ws.onmessage = self.onMessage; - }, - connect: function(callback) { - callback = callback || angular.noop; - if (self.isConnecting()) { - self.onNext('open', callback); - } else if (self.isClosing()) { - self.onNext('close', function () { - self.connect(callback); - }); - } else if (self.isClosed()) { - self._connect(); - self.onNext('open', callback); - } else if (self.isOpen()) { - callback(); - } else { - $log.error('Error which should never happen: websocket is in an unknown state', self.getStatus()); - } - }, - - close: function (code, reason) { - if (self.ws) { - try { - if (!self.isClosed()) { - self.ws.onopen = self.ws.onclose = self.ws.onerror = self.ws.onmessage = null; - self.ws.close(code || 1000, reason || 'manual close'); - } - self.onClose(); - } catch (ex) { - $log.error('error calling close on', self.getStatusString(), 'websocket', ex); - } - delete self.ws; - } - }, - - refireSubscriptions: function () { - angular.forEach(self.requests, function (request) { - if (request.method && request.client) { - self.send(request); - } - }); - }, - - onOpen: function () { - self.currReconnectWait = self.MIN_RECONNECT_WAIT; - self.schedulePoll(); - self.refireSubscriptions(); - $rootScope.$broadcast('WebSocketService.open'); - }, - onError: function (event) { - $log.error('websocket error', event); - self.close(); - }, - onClose: function () { - self.stopPolling(); - $timeout(self.connect, self.currReconnectWait); - self.currReconnectWait = Math.min(self.MAX_RECONNECT_WAIT, 2 * self.currReconnectWait); - $rootScope.$broadcast('WebSocketService.close'); - }, - onMessage: function (event) { - var json; - try { - json = JSON.parse(event.data || 'null'); - } catch (ex) { - $log.error('websocket message parse error', event, ex); - return; - } - if (!json || !angular.isObject(json)) { - $log.error('websocket message parsed to a non-object', json); - } else { - self.handleMessage(json); - } - }, - - handleMessage: function (message) { - var request = self.requests[message.client || message.callback]; - if (request) { - $log.debug('websocket received', message); - var funcAttr = message.error ? 'error' : 'callback', - dataAttr = message.error ? 'error' : 'data'; - try { - request[funcAttr](message[dataAttr]); - } catch(ex) { - $log.error('Error executing websocket', funcAttr, 'function:', ex); - } - if (request.callbackId) { - delete self.requests[request.callbackId]; - } - $rootScope.$digest(); - } else { - $log.error('unknown client and/or callback id', message); - } - }, - - send: function(request) { - if (request.method && (request.client || request.callbackId)) { - self.requests[request.client || request.callbackId] = request; - } - var message = JSON.stringify({ - action: request.action, - method: request.method, - params: request.params, - client: request.client, - callback: request.callbackId - }); - $log.debug('websocket send', message); - self.ws.send(message); - }, - connectAndSend: function (request) { - self.connect(function () { - self.send(request); - }); - }, - - subscribe: function(request) { - request = self.normalizeRequest(request, {single: false}); - if (request.method) { - self.connectAndSend(request); - return request.client; - } else { - $log.error('"method" is a required field for WebSocketService.subscribe()'); - } - }, - - unsubscribe: function() { - var clients = []; - angular.forEach(arguments, function (request) { - request = self.objectify(request); - if (request.client && self.requests[request.client]) { - if (request.callback) { - $log.warn('ignoring callback field, which is invalid for unsubscribe', request); - } - clients.push(request.client); - delete self.requests[request.client]; - } else { - $log.error('Unsubscribe called with unknown client id', request); - } - }); - if (self.isOpen() && clients.length) { - self.send({action: 'unsubscribe', client: clients}); - } - }, - - call: function(request) { - if (typeof(request) === 'string') { - request = { - method: request, - params: Array.prototype.slice.call(arguments, 1) - }; - } - request = self.objectify(request); - var errorMessage = !request.method ? '"method" required for WebSocketService.call()' : - request.callback ? '"callback" is not a valid field for WebSocketService.call()' : - request.error ? '"error" is not a valid field for WebSocketService.call()' : null; - if (!errorMessage) { - var deferred = $q.defer(); - request = self.normalizeRequest(request, { - single: true, - error: deferred.reject, - callback: deferred.resolve - }); - request.timeout = request.timeout || self.CALL_TIMEOUT; - var rejectAfterTimeout = $timeout(function () { - $log.error('no response received for', request.timeout, 'milliseconds', request); - deferred.reject('websocket call timed out'); - }, request.timeout); - self.connectAndSend(request); - return deferred.promise.finally(function () { - $timeout.cancel(rejectAfterTimeout); - delete self.requests[request.callbackId]; - }); - } else { - $log.error(errorMessage); - return $q.reject(errorMessage); - } - } - }; - return self; - }); diff --git a/sideboard/templates/connections.html b/sideboard/templates/connections.html deleted file mode 100644 index f62ac69..0000000 --- a/sideboard/templates/connections.html +++ /dev/null @@ -1,17 +0,0 @@ - - - - Sideboard Connection Tests - - -

Sideboard Connection Tests

- {% for service, results in connections.items()|sort %} -

{{ service }}

-
    - {% for line in results %} -
  • {{ line }}
    • - {% endfor %} -
- {% endfor %} - - diff --git a/sideboard/templates/list_plugins.html b/sideboard/templates/list_plugins.html deleted file mode 100644 index efc552b..0000000 --- a/sideboard/templates/list_plugins.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - Sideboard Plugins - - -

Welcome to Sideboard (version {{ version|default('not specified', true) }})

-

Sideboard documentation

-

There are {{ plugins|length }} plugins installed

- - {% for path, plugin in plugins.items()|sort %} - - - - - - - {% endfor %} -
{{ plugin.name }}(version {{ plugin.version|default('not specified', true) }}) - {% for path in plugin.paths %} - {{ path }} - {% endfor %} -
- - diff --git a/sideboard/templates/login.html b/sideboard/templates/login.html deleted file mode 100644 index dcad459..0000000 --- a/sideboard/templates/login.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - Login - - - -
{{ message }}
-
- - - - - - - - - - - - - - - - - - diff --git a/sideboard/tests/__init__.py b/sideboard/tests/__init__.py index 8ec5e3f..ea4e728 100644 --- a/sideboard/tests/__init__.py +++ b/sideboard/tests/__init__.py @@ -4,12 +4,8 @@ from contextlib import closing import pytest -import sqlalchemy -from sqlalchemy import event -from sqlalchemy.orm import sessionmaker -from sqlalchemy.pool import NullPool -from sideboard.lib import config, services +from sideboard.lib import config def get_available_port(): @@ -36,23 +32,6 @@ def get_available_port(): return sock.getsockname()[1] -@pytest.fixture -def service_patcher(request): - class TestService(object): - def __init__(self, methods): - self.__dict__.update(methods) - - def patch(name, service): - if isinstance(service, dict): - service = TestService(service) - orig_service = services.get_services().get(name) - services.register(service, name) - request.addfinalizer(lambda: services.get_services().pop(name, None)) - if orig_service: - request.addfinalizer(lambda: services.get_services().update({name: orig_service})) - return patch - - @pytest.fixture def config_patcher(request): def patch_config(value, *path, **kwargs): @@ -63,17 +42,3 @@ def patch_config(value, *path, **kwargs): request.addfinalizer(lambda: conf.__setitem__(path[-1], orig_val)) conf[path[-1]] = value return patch_config - - -def patch_session(Session, request): - orig_engine, orig_factory = Session.engine, Session.session_factory - request.addfinalizer(lambda: setattr(Session, 'engine', orig_engine)) - request.addfinalizer(lambda: setattr(Session, 'session_factory', orig_factory)) - - name = Session.__module__.split('.')[0] - db_path = '/tmp/{}.db'.format(name) - Session.engine = sqlalchemy.create_engine('sqlite+pysqlite:///' + db_path, poolclass=NullPool) - event.listen(Session.engine, 'connect', lambda conn, record: conn.execute('pragma foreign_keys=ON')) - Session.session_factory = sessionmaker(bind=Session.engine, autoflush=False, autocommit=False, - query_cls=Session.QuerySubclass) - Session.initialize_db(drop=True) diff --git a/sideboard/tests/test_configuration.py b/sideboard/tests/test_configuration.py deleted file mode 100644 index e175a42..0000000 --- a/sideboard/tests/test_configuration.py +++ /dev/null @@ -1,201 +0,0 @@ -from __future__ import unicode_literals -import os - -import pytest -from mock import Mock - -from sideboard.lib import config -from sideboard.config import get_config_files, get_config_overrides, get_config_root, get_module_and_root_dirs, parse_config, uniquify - - -def test_uniquify(): - pytest.raises(AssertionError, uniquify, None) - assert [] == uniquify([]) - assert ['a', 'b', 'c'] == uniquify(['a', 'b', 'c']) - assert ['a', 'b', 'c', 'd', 'e'] == uniquify(['a', 'b', 'a', 'c', 'a', 'd', 'a', 'e']) - assert ['a'] == uniquify(['a', 'a', 'a', 'a', 'a', 'a', 'a', 'a']) - - -@pytest.mark.skipif( - 'SIDEBOARD_CONFIG_OVERRIDES' not in os.environ, - reason='SIDEBOARD_CONFIG_OVERRIDES not set') -def test_test_defaults_ini(): - """ - Verify that the tests were launched using `test-defaults.ini`. - - All of the other sideboard tests will succeed whether `test-defaults.ini` - or `development-defaults.ini` is used. This test is actually a functional - test of sorts; it verifies the test suite itself was launched with - `SIDEBOARD_CONFIG_OVERRIDES="test-defaults.ini"`. - - The test is skipped rather than failing if the tests were launched without - setting `SIDEBOARD_CONFIG_OVERRIDES`. - """ - from sideboard.lib import config - # is_test_running is ONLY set in test-defaults.ini - assert config.get('is_test_running') - - -class SideboardConfigurationTest(object): - sideboard_root = os.path.abspath(os.path.join(__file__, '..', '..', '..')) - dev_test_plugin_path = os.path.join(sideboard_root, 'plugins', 'configuration-test', - 'configuration_test', '__init__.py') - production_test_plugin_path = os.path.join('/', 'opt', 'sideboard', 'plugins', 'configuration-test', - 'env', 'lib', 'python{py_version}', 'site-packages', - 'configuration_test-{plugin_ver}-{py_version}.egg', - 'configuration_test', '__init__.py') - - def test_parse_config_adding_root_and_module_root_for_dev(self): - test_config = parse_config(self.dev_test_plugin_path) - expected_module_root = os.path.dirname(self.dev_test_plugin_path) - expected_root = os.path.dirname(expected_module_root) - assert test_config.get('module_root') == expected_module_root - assert test_config.get('root') == expected_root - - def test_parse_config_adding_root_and_module_root_for_production(self): - for path_values in (dict(py_version='2.7', plugin_ver='1.0'),): - test_path = self.production_test_plugin_path.format(**path_values) - test_config = parse_config(test_path) - expected_module_root = os.path.dirname(test_path) - expected_root = os.path.join('/', 'opt', 'sideboard', 'plugins', 'configuration-test') - assert test_config.get('module_root') == expected_module_root - assert test_config.get('root') == expected_root - - -class TestSideboardGetConfigFiles(object): - @pytest.fixture - def config_overrides_unset(self, monkeypatch): - monkeypatch.delenv('SIDEBOARD_CONFIG_OVERRIDES', raising=False) - - @pytest.fixture - def config_overrides_set(self, monkeypatch): - monkeypatch.setenv('SIDEBOARD_CONFIG_OVERRIDES', 'test-defaults.ini') - - @pytest.fixture - def plugin_dirs(self): - module_path = '/fake/sideboard/plugins/test-plugin/test_plugin' - root_path = os.path.join(config['plugins_dir'], 'test-plugin') - return (module_path, root_path) - - @pytest.fixture - def sideboard_dirs(self): - module_path = '/fake/sideboard/sideboard' - root_path = '/fake/sideboard' - return (module_path, root_path) - - def test_get_module_and_root_dirs_plugin(self, plugin_dirs): - assert plugin_dirs == get_module_and_root_dirs( - os.path.join(plugin_dirs[0], 'config.py'), is_plugin=True) - - def test_get_module_and_root_dirs_sideboard(self, sideboard_dirs): - assert sideboard_dirs == get_module_and_root_dirs( - os.path.join(sideboard_dirs[0], 'config.py'), is_plugin=False) - - def test_get_config_files_plugin(self, plugin_dirs, config_overrides_unset): - expected = [ - '/etc/sideboard/plugins.d/test-plugin.cfg', - os.path.join(plugin_dirs[1], 'development-defaults.ini'), - os.path.join(plugin_dirs[1], 'development.ini')] - assert expected == get_config_files( - os.path.join(plugin_dirs[0], 'config.py'), is_plugin=True) - - def test_get_config_files_sideboard(self, sideboard_dirs, config_overrides_unset): - expected = [ - '/etc/sideboard/sideboard-core.cfg', - '/etc/sideboard/sideboard-server.cfg', - os.path.join(sideboard_dirs[1], 'development-defaults.ini'), - os.path.join(sideboard_dirs[1], 'development.ini')] - assert expected == get_config_files( - os.path.join(sideboard_dirs[0], 'config.py'), is_plugin=False) - - def test_get_config_files_plugin_with_overrides(self, plugin_dirs, config_overrides_set): - expected = [ - '/etc/sideboard/plugins.d/test-plugin.cfg', - os.path.join(plugin_dirs[1], 'test-defaults.ini'), - os.path.join(plugin_dirs[1], 'test.ini')] - assert expected == get_config_files( - os.path.join(plugin_dirs[0], 'config.py'), is_plugin=True) - - def test_get_config_files_sideboard_with_overrides(self, sideboard_dirs, config_overrides_set): - expected = [ - '/etc/sideboard/sideboard-core.cfg', - '/etc/sideboard/sideboard-server.cfg', - os.path.join(sideboard_dirs[1], 'test-defaults.ini'), - os.path.join(sideboard_dirs[1], 'test.ini')] - assert expected == get_config_files( - os.path.join(sideboard_dirs[0], 'config.py'), is_plugin=False) - - -class TestSideboardGetConfigOverrides(object): - @pytest.fixture(params=[ - (None, ['development-defaults.ini', 'development.ini']), - ('test-defaults.ini', ['test-defaults.ini', 'test.ini']), - ('test.ini;development.ini;test.ini', ['test.ini', 'development.ini']), - ('test-defaults.ini;test-defaults.ini', ['test-defaults.ini', 'test.ini']), - (' /absolute/path.ini ', ['/absolute/path.ini']), - ('/absolute/path.cfg', ['/absolute/path.cfg']), - (' relative/path.ini ', ['relative/path.ini']), - ('relative/path.cfg', ['relative/path.cfg']), - ('/absolute/path.cfg;relative/path.ini', ['/absolute/path.cfg', 'relative/path.ini']), - ('relative/path.cfg;/absolute/path.ini', ['relative/path.cfg', '/absolute/path.ini']), - (' /absolute/path.cfg ; relative/path.ini ', ['/absolute/path.cfg', 'relative/path.ini']), - (' /absolute/path-defaults.ini ', ['/absolute/path-defaults.ini', '/absolute/path.ini']), - ('/absolute/path-defaults.cfg', ['/absolute/path-defaults.cfg', '/absolute/path.cfg']), - (' relative/path-defaults.ini ', ['relative/path-defaults.ini', 'relative/path.ini']), - ('relative/path-defaults.cfg', ['relative/path-defaults.cfg', 'relative/path.cfg']), - ('/absolute/path-defaults.cfg;relative/path-defaults.ini', [ - '/absolute/path-defaults.cfg', - '/absolute/path.cfg', - 'relative/path-defaults.ini', - 'relative/path.ini' - ]) - ]) - def config_overrides(self, request, monkeypatch): - if request.param[0] is None: - monkeypatch.delenv('SIDEBOARD_CONFIG_OVERRIDES', raising=False) - else: - monkeypatch.setenv('SIDEBOARD_CONFIG_OVERRIDES', request.param[0]) - return request.param[1] - - def test_get_config_overrides(self, config_overrides): - assert get_config_overrides() == config_overrides - - -class TestSideboardGetConfigRoot(object): - @pytest.fixture - def dir_missing(self, monkeypatch): - monkeypatch.setattr(os.path, 'isdir', Mock(return_value=False)) - - @pytest.fixture - def dir_exists(self, monkeypatch): - monkeypatch.setattr(os.path, 'isdir', Mock(return_value=True)) - - @pytest.fixture - def dir_readable(self, monkeypatch): - monkeypatch.setattr(os, 'access', Mock(return_value=True)) - - @pytest.fixture - def dir_unreadable(self, monkeypatch): - monkeypatch.setattr(os, 'access', Mock(return_value=False)) - - @pytest.fixture - def custom_root(self, monkeypatch): - monkeypatch.setitem(os.environ, 'SIDEBOARD_CONFIG_ROOT', '/custom/location') - - def test_valid_etc_sideboard(self, dir_exists, dir_readable): - assert get_config_root() == '/etc/sideboard' - - def test_no_etc_sideboard(self, dir_missing): - assert get_config_root() == '/etc/sideboard' - - def test_etc_sideboard_unreadable(self, dir_exists, dir_unreadable): - pytest.raises(AssertionError, get_config_root) - - def test_overridden_missing(self, custom_root, dir_missing): - pytest.raises(AssertionError, get_config_root) - - def test_overridden_unreadable(self, custom_root, dir_exists, dir_unreadable): - pytest.raises(AssertionError, get_config_root) - - def test_overridden_valid(self, custom_root, dir_exists, dir_readable): - assert get_config_root() == '/custom/location' diff --git a/sideboard/tests/test_jsonrpc.py b/sideboard/tests/test_jsonrpc.py deleted file mode 100644 index 3848baa..0000000 --- a/sideboard/tests/test_jsonrpc.py +++ /dev/null @@ -1,83 +0,0 @@ -from __future__ import unicode_literals -import json - -import pytest -import cherrypy -from mock import Mock - -from sideboard.lib import services -from sideboard.tests import service_patcher -from sideboard.jsonrpc import _make_jsonrpc_handler - - -@pytest.fixture -def precall(): - return Mock() - - -@pytest.fixture -def raw_jsonrpc(service_patcher, precall, monkeypatch): - service_patcher('test', {'get_message': lambda name: 'Hello {}!'.format(name)}) - - def caller(parsed): - cherrypy.request.json = parsed - result = _make_jsonrpc_handler(services.get_services(), precall=precall)(self=None) - return result - return caller - - -@pytest.fixture -def jsonrpc(raw_jsonrpc): - def caller(method, *args, **kwargs): - return raw_jsonrpc({ - 'method': method, - 'params': kwargs or list(args) - }) - return caller - - -def test_precall(jsonrpc, precall): - jsonrpc('test.get_message', 'World') - assert precall.called - - -def test_valid_args(jsonrpc): - assert jsonrpc('test.get_message', 'World')['result'] == 'Hello World!' - - -def test_valid_kwargs(jsonrpc): - assert jsonrpc('test.get_message', name='World')['result'] == 'Hello World!' - - -def test_non_object(raw_jsonrpc): - response = raw_jsonrpc('not actually json') - assert 'invalid json input' in response['error']['message'] - - -def test_no_method(raw_jsonrpc): - assert '"method" field required' in raw_jsonrpc({})['error']['message'] - - -def test_invalid_method(jsonrpc): - assert 'invalid method' in jsonrpc('')['error']['message'] - assert 'invalid method' in jsonrpc('no_module')['error']['message'] - assert 'invalid method' in jsonrpc('too.many.modules')['error']['message'] - - -def test_missing_module(jsonrpc): - assert 'no module' in jsonrpc('invalid.module')['error']['message'] - - -def test_missing_function(jsonrpc): - assert 'no function' in jsonrpc('test.does_not_exist')['error']['message'] - - -def test_invalid_params(raw_jsonrpc): - assert 'invalid parameter list' in raw_jsonrpc({ - 'method': 'test.get_message', - 'params': 'not a list or dict' - })['error']['message'] - - -def test_exception(jsonrpc): - assert 'unexpected error' in jsonrpc('test.get_message')['error']['message'] diff --git a/sideboard/tests/test_lib.py b/sideboard/tests/test_lib.py index 4523d55..25607a3 100644 --- a/sideboard/tests/test_lib.py +++ b/sideboard/tests/test_lib.py @@ -1,303 +1,11 @@ from __future__ import unicode_literals import json -from time import sleep -from itertools import count from unittest import TestCase from datetime import datetime, date -from collections.abc import Sequence, Set -from threading import current_thread, Thread -import six import pytest -import cherrypy -from mock import Mock -from sideboard.lib._services import _Services -from sideboard.websockets import local_broadcast, local_subscriptions, local_broadcaster -from sideboard.lib import Model, serializer, ajax, is_listy, log, notify, locally_subscribes, cached_property, request_cached_property, threadlocal, register_authenticator, restricted, all_restricted, RWGuard - - -class TestServices(TestCase): - def setUp(self): - self.services = _Services() - - def test_service_registration(self): - self.services.register(self, 'foo') - self.services.foo.assertTrue(True) - - def test_service_double_registration(self): - self.services.register(self, 'foo') - self.services.register(self, 'bar') - self.assertRaises(AssertionError, self.services.register, self, 'foo') - - def test_service_preregistration_getattr(self): - foo = self.services.foo - self.services.register(self, 'foo') - foo.assertTrue(True) - - def test_method_whitelisting(self): - """ - When __all__ is defined for a service, we should raise an exception if - a client calls a method whose name is not inclueded in __all__. - """ - self.__all__ = ['bar'] - self.bar = self.baz = lambda: 'Hello World' - self.services.register(self, 'foo') - assert 'Hello World' == self.services.foo.bar() - with pytest.raises(AssertionError): - self.services.foo.baz() - - -class TestModel(TestCase): - def assert_model(self, data, unpromoted=None): - model = Model(data, 'test', unpromoted) - self.assertEqual('some_uuid', model.id) - self.assertEqual('some_uuid', model['id']) - self.assertEqual(5, model.foo) - self.assertEqual(5, model['foo']) - self.assertEqual({'baz': 'baf'}, model.bar) - self.assertEqual({'baz': 'baf'}, model['bar']) - - def test_missing_key(self): - model = Model({}, 'test') - self.assertIs(None, model.does_not_exist) - - def test_id_unsettable(self): - model = Model({'id': 'some_uuid'}, 'test') - model.id = 'some_uuid' - model['id'] = 'some_uuid' - self.assertEqual(model.id, 'some_uuid') - with self.assertRaises(Exception): - model.id = 'another_uuid' - with self.assertRaises(Exception): - model['id'] = 'another_uuid' - - def test_extra_data_only(self): - d = { - 'id': 'some_uuid', - 'extra_data': { - 'test_foo': 5, - 'test_bar': {'baz': 'baf'} - } - } - for data in [d, dict(d, test_data={})]: - self.assert_model(data) - - model = Model(d, 'test') - model.fizz = 'buzz' - model['buzz'] = 'fizz' - self.assertEqual('fizz', model._data['extra_data']['test_buzz']) - self.assertEqual('buzz', model._data['extra_data']['test_fizz']) - - def test_project_data(self): - d = { - 'id': 'some_uuid', - 'test_data': { - 'foo': 5, - 'bar': {'baz': 'baf'} - } - } - for data in [d, dict(d, extra_data={})]: - self.assert_model(data) - model = Model(data, 'test') - model.fizz = 'buzz' - model['buzz'] = 'fizz' - self.assertEqual('fizz', model._data['test_data']['buzz']) - self.assertEqual('buzz', model._data['test_data']['fizz']) - - def test_both_data(self): - data = { - 'id': 'some_uuid', - 'extra_data': { - 'test_foo': 5 - }, - 'test_data': { - 'bar': {'baz': 'baf'} - } - } - self.assert_model(data) - model = Model(data, 'test') - model.fizz = 'buzz' - model['buzz'] = 'fizz' - self.assertEqual('fizz', model._data['test_data']['buzz']) - self.assertEqual('buzz', model._data['test_data']['fizz']) - model.foo = 6 - model.bar = {'baf': 'baz'} - self.assertEqual({}, model._data['extra_data']) - self.assertEqual(6, model.foo) - self.assertEqual({'baf': 'baz'}, model['bar']) - self.assertEqual(6, model._data['test_data']['foo']) - self.assertEqual({'baf': 'baz'}, model._data['test_data']['bar']) - - def test_unpromoted_prepromotion(self): - data = { - 'id': 'some_uuid', - 'extra_data': { - 'foo': 5, - 'test_bar': {'baz': 'baf'} - } - } - self.assert_model(data, {'foo'}) - model = Model(data, 'test', unpromoted={'foo'}) - model.foo = 6 - self.assertEqual(6, model.foo) - self.assertNotIn('foo', model._data) - self.assertEqual(6, model._data['extra_data']['foo']) - - def test_unpromoted_postpromotion(self): - data = { - 'id': 'some_uuid', - 'foo': 5, - 'extra_data': { - 'test_bar': {'baz': 'baf'} - } - } - self.assert_model(data, {'foo'}) - model = Model(data, 'test', unpromoted={'foo'}) - model.foo = 6 - self.assertEqual(6, model.foo) - self.assertEqual(6, model._data['foo']) - self.assertNotIn('foo', model._data['extra_data']) - - def test_unpromoted_not_present(self): - data = {'id': 'some_uuid'} - model = Model(data, 'test', unpromoted={'foo'}) - self.assertIs(None, model.foo) - model.foo = 'bar' - self.assertEqual('bar', model.foo) - self.assertNotIn('foo', model._data) - self.assertEqual('bar', model._data['extra_data']['foo']) - - def test_subclass(self): - self.assertRaises(Exception, Model, {}) - - class TestModel(Model): - _prefix = 'test' - _unpromoted = {'foo'} - _defaults = {'baz': 'baf'} - - data = {'id': 'some_uuid'} - model = TestModel(data) - self.assertIs(None, model.foo) - model.foo = 'bar' - self.assertEqual('baf', model.baz) - self.assertEqual('bar', model.foo) - self.assertNotIn('foo', model._data) - self.assertEqual('bar', model._data['extra_data']['foo']) - - def test_defaults(self): - data = { - 'extra_data': { - 'test_foo': -1, - 'bar': -2 - }, - 'test_data': { - 'baz': -3 - }, - 'baf': -4 - } - model = Model(data, 'test', {'bar', 'baf', 'fizz'}, { - 'foo': 1, - 'bar': 2, - 'baz': 3, - 'baf': 4, - 'fizz': 5, - 'buzz': 6 - }) - self.assertEqual(model.foo, -1) - self.assertEqual(model.bar, -2) - self.assertEqual(model.baz, -3) - self.assertEqual(model.baf, -4) - self.assertEqual(model.fizz, 5) - self.assertEqual(model.buzz, 6) - model.foo, model.bar, model.baz, model.baf = range(11, 15) - self.assertEqual(model.foo, 11) - self.assertEqual(model.bar, 12) - self.assertEqual(model.baz, 13) - self.assertEqual(model.baf, 14) - self.assertEqual(model.fizz, 5) - self.assertEqual(model.buzz, 6) - - def test_to_dict(self): - data = { - 'id': 'some_uuid', - 'extra_data': { - 'test_foo': 5, - 'fizz': 'buzz', - 'spam': 'eggs' - }, - 'test_data': {'bar': 'baz'} - } - model = Model(data, 'test', {'fizz'}) - serialized = { - 'id': 'some_uuid', - 'foo': 5, - 'bar': 'baz', - 'fizz': 'buzz', - 'extra_data': {'spam': 'eggs'} - } - self.assertEqual(model.to_dict(), serialized) - serialized.pop('extra_data') - self.assertEqual(dict(model), serialized) - - def test_query(self): - model = Model({'_model': 'Test', 'id': 'some_uuid'}, 'test') - self.assertEqual(model.query, { - '_model': 'Test', - 'field': 'id', - 'value': 'some_uuid' - }) - for data in [{}, {'_model': 'Test'}, {'id': 'some_uuid'}]: - with self.assertRaises(Exception): - Model(data, 'test').query - - def test_dirty(self): - data = { - 'id': 'some_uuid', - 'spam': 'eggs', - 'extra_data': { - 'test_foo': 5 - }, - 'test_data': { - 'bar': {'baz': 'baf'} - } - } - self.assertEqual(Model(data, 'test').dirty, {}) - - model = Model(data, 'test') - model.spam = 'nee' - self.assertEqual(model.dirty, {'spam': 'nee'}) - - model = Model(data, 'test') - model.foo = 6 - self.assertEqual(model.dirty, {'extra_data': {}, 'test_data': {'foo': 6, 'bar': {'baz': 'baf'}}}) - - model = Model(data, 'test') - model.bar = {'fizz': 'buzz'} - self.assertEqual(model.dirty, {'test_data': {'bar': {'fizz': 'buzz'}}}) - - model = Model(data, 'test') - model.bar['baz'] = 'zab' - self.assertEqual(model.dirty, {'test_data': {'bar': {'baz': 'zab'}}}) - - model = Model(data, 'test') - model.foo = 6 - model.bar = 'baz' - model.spam = 'nee' - model.fizz = 'buzz' - self.assertEqual(model.dirty, { - 'spam': 'nee', - 'test_data': { - 'foo': 6, - 'bar': 'baz', - 'fizz': 'buzz' - }, - 'extra_data': {} - }) - - model = Model({}, 'test') - model.foo = 'bar' - self.assertEqual(model.dirty, {'extra_data': {'test_foo': 'bar'}}) +from sideboard.lib import serializer class TestSerializer(TestCase): @@ -353,279 +61,3 @@ class Bax(Foo): pass json.dumps(Baz(), cls=serializer) # undefined which function will be used json.dumps(Bax(), cls=serializer) # undefined which function will be used """ - - -class TestIsListy(TestCase): - """ - We test all sequence types, set types, and mapping types listed at - http://docs.python.org/2/library/stdtypes.html plus a few example - user-defined collections subclasses. - """ - - def test_sized_builtin(self): - sized = [(), (1,), [], [1], set(), set([1]), frozenset(), frozenset([1]), - bytearray(), bytearray(1)] - if six.PY2: - sized.extend([xrange(0), xrange(2), buffer(''), buffer('x')]) - for x in sized: - assert is_listy(x) - - def test_excluded(self): - assert not is_listy({}) - assert not is_listy('') - assert not is_listy(b'') - - def test_unsized_builtin(self): - assert not is_listy(iter([])) - assert not is_listy(i for i in range(2)) - - def test_user_defined_types(self): - assert not is_listy(Model({}, 'test')) - - class AlwaysEmptySequence(Sequence): - def __len__(self): return 0 - - def __getitem__(self, i): return [][i] - - assert is_listy(AlwaysEmptySequence()) - - class AlwaysEmptySet(Set): - def __len__(self): return 0 - - def __iter__(self): return iter([]) - - def __contains__(self, x): return False - - assert is_listy(AlwaysEmptySet()) - - def test_miscellaneous(self): - class Foo(object): - pass - - for x in [0, 1, False, True, Foo, object, object()]: - assert not is_listy(x) - - -def test_ajaz_serialization(): - class Root(object): - @ajax - def returns_date(self): - return date(2001, 2, 3) - assert '"2001-02-03"' == Root().returns_date() - - -def test_trace_logging(): - log.trace('normally this would be an error') - - -class TestLocallySubscribes(object): - @pytest.fixture(autouse=True) - def counter(self): - _counter = count() - - @locally_subscribes('foo', 'bar') - def counter(): - return next(_counter) - - yield counter - local_subscriptions.clear() - - def test_basic(self, counter): - local_broadcast(['foo', 'bar']) - assert 1 == counter() # was only called once even though it matched multiple channels - - def test_exception(self): - errored = Mock(side_effect=ValueError) - working = Mock() - locally_subscribes('foo')(errored) - locally_subscribes('foo')(working) - local_broadcast('foo') - assert errored.called and working.called # exception didn't halt execution - - def test_notify_triggers_local_updates(self, monkeypatch): - monkeypatch.setattr(local_broadcaster, 'defer', Mock()) - notify('foo') - local_broadcaster.defer.assert_called_with(['foo'], trigger='manual', originating_client=None) - - -def test_cached_property(): - class Foo(object): - @cached_property - def bar(self): - return 5 - - foo = Foo() - assert not hasattr(foo, '_cached_bar') - assert 5 == foo.bar - assert 5 == foo._cached_bar - foo._cached_bar = 6 - assert 6 == foo.bar - assert 5 == Foo().bar # per-instance caching - - -def test_request_cached_property(): - class Foo(object): - @request_cached_property - def bar(self): - return 5 - - name = __name__ + '.bar' - foo = Foo() - assert threadlocal.get(name) is None - assert 5 == foo.bar - assert 5 == threadlocal.get(name) - threadlocal.set(name, 6) - assert 6 == foo.bar - assert 6 == Foo().bar # cache is shared between instances - - -class TestPluggableAuth(object): - @pytest.fixture(scope='session', autouse=True) - def mock_authenticator(self): - register_authenticator('test', '/mock_login_page', lambda: 'uid' in cherrypy.session) - - @pytest.fixture(autouse=True) - def mock_session(self, monkeypatch): - monkeypatch.setattr(cherrypy, 'session', {}, raising=False) - - def mock_login(self): - cherrypy.session['uid'] = 123 - - def test_double_registration(self): - pytest.raises(Exception, register_authenticator, 'test', 'already registered', lambda: 'this will not register due to an exception') - - def test_unknown_authenticator(self): - pytest.raises(Exception, all_restricted, 'unknown_authenticator') - - def test_all_restricted(self): - self.called = False - - @all_restricted('test') - class AllRestricted(object): - def index(inner_self): - self.called = True - - with pytest.raises(cherrypy.HTTPRedirect) as exc: - AllRestricted().index() - assert not self.called and exc.value.args[0][0].endswith('/mock_login_page') - - self.mock_login() - AllRestricted().index() - assert self.called - - def test_restricted(self): - self.called = False - - class SingleRestricted(object): - @restricted('test') - def index(inner_self): - self.called = True - - with pytest.raises(cherrypy.HTTPRedirect) as exc: - SingleRestricted().index() - assert not self.called and exc.value.args[0][0].endswith('/mock_login_page') - - self.mock_login() - SingleRestricted().index() - assert self.called - - -class TestRWGuard(object): - @pytest.fixture - def guard(self, monkeypatch): - guard = RWGuard() - monkeypatch.setattr(guard.ready_for_writes, 'notify', Mock()) - monkeypatch.setattr(guard.ready_for_reads, 'notify_all', Mock()) - return guard - - def test_read_locked_tracking(self, guard): - assert {} == guard.acquired_readers - with guard.read_locked: - assert {current_thread().ident: 1} == guard.acquired_readers - with guard.read_locked: - assert {current_thread().ident: 2} == guard.acquired_readers - assert {current_thread().ident: 1} == guard.acquired_readers - assert {} == guard.acquired_readers - - def test_write_locked_tracking(self, guard): - assert {} == guard.acquired_writer - with guard.write_locked: - assert {current_thread().ident: 1} == guard.acquired_writer - with guard.write_locked: - assert {current_thread().ident: 2} == guard.acquired_writer - assert {current_thread().ident: 1} == guard.acquired_writer - assert {} == guard.acquired_writer - - def test_multi_read_locking_allowed(self, guard): - guard.acquired_readers['mock-thread-ident'] = 1 - with guard.read_locked: - pass - - def test_read_write_exclusion(self, guard): - with guard.read_locked: - with pytest.raises(AssertionError): - with guard.write_locked: - pass - - def test_write_read_exclusion(self, guard): - with guard.write_locked: - with pytest.raises(Exception): - with guard.read_locked: - pass - - def test_release_requires_acquisition(self, guard): - pytest.raises(AssertionError, guard.release) - - def test_wake_readers(self, guard): - with guard.read_locked: - guard.waiting_writer_count = 1 - assert not guard.ready_for_reads.notify_all.called - - guard.waiting_writer_count = 0 - with guard.read_locked: - pass - assert guard.ready_for_reads.notify_all.called - - def test_wake_writers(self, guard): - with guard.write_locked: - guard.acquired_readers['mock-tid'] = 1 - guard.waiting_writer_count = 1 - assert not guard.ready_for_writes.notify.called - - guard.acquired_readers.clear() - with guard.write_locked: - guard.waiting_writer_count = 0 - assert not guard.ready_for_writes.notify.called - - with guard.write_locked: - guard.waiting_writer_count = 1 - assert guard.ready_for_writes.notify.called - - def test_threading(self): - guard = RWGuard() - read, written = [False], [False] - - def reader(): - with guard.read_locked: - read[0] = True - - def writer(): - with guard.write_locked: - written[0] = True - - with guard.write_locked: - Thread(target=reader).start() - Thread(target=writer).start() - sleep(0.1) - assert not read[0] and not written[0] - sleep(0.1) - assert read[0] and written[0] - - read, written = [False], [False] - with guard.read_locked: - Thread(target=reader).start() - Thread(target=writer).start() - sleep(0.1) - assert read[0] and not written[0] - sleep(0.1) - assert read[0] and written[0] diff --git a/sideboard/tests/test_logging.py b/sideboard/tests/test_logging.py deleted file mode 100644 index f0043ee..0000000 --- a/sideboard/tests/test_logging.py +++ /dev/null @@ -1,20 +0,0 @@ -from __future__ import unicode_literals -import logging -import unittest - -from six import StringIO - - -class LoggerSetupTest(unittest.TestCase): - def _stream(self): - return StringIO() - - def _logger(self, logger_name, stream): - logging.getLogger().addHandler(logging.StreamHandler(stream)) - return logging.getLogger(logger_name) - - def test_importing_sideboard_doesnt_break_dummy_logger(self): - stream = self._stream() - dummy_logger = self._logger('dummy', stream) - dummy_logger.warning('do not break dummy logger') - assert stream.getvalue() == 'do not break dummy logger\n' diff --git a/sideboard/tests/test_profiler.py b/sideboard/tests/test_profiler.py deleted file mode 100644 index 57e4894..0000000 --- a/sideboard/tests/test_profiler.py +++ /dev/null @@ -1,17 +0,0 @@ -from __future__ import unicode_literals -from sideboard.lib import cleanup_profiler, profile -from sideboard.config import config - - -def some_function(): - pass - - -def test_profile_is_noop(monkeypatch): - monkeypatch.setitem(config['cherrypy'], 'profiling.on', False) - profiled = profile(some_function) - assert profiled is some_function - - monkeypatch.setitem(config['cherrypy'], 'profiling.on', True) - profiled = profile(some_function) - assert profiled is not some_function diff --git a/sideboard/tests/test_sa.py b/sideboard/tests/test_sa.py deleted file mode 100644 index 981d34d..0000000 --- a/sideboard/tests/test_sa.py +++ /dev/null @@ -1,1081 +0,0 @@ -from __future__ import unicode_literals -import uuid -import shutil -from datetime import datetime - -import pytest - -import sqlalchemy -from sqlalchemy.ext.hybrid import hybrid_property -from sqlalchemy.pool import NullPool -from sqlalchemy.orm import relationship -from sqlalchemy.types import Boolean, Integer, UnicodeText -from sqlalchemy.schema import Column, CheckConstraint, ForeignKey, MetaData, Table, UniqueConstraint -from sqlalchemy.sql import case - -from sideboard.lib import log, listify -from sideboard.tests import patch_session -from sideboard.lib.sa._crud import normalize_query, collect_ancestor_classes -from sideboard.lib.sa import check_constraint_naming_convention, crudable, declarative_base, \ - regex_validation, text_length_validation, CrudException, JSON, SessionManager, UUID - - -@declarative_base -class Base(object): - id = Column(UUID(), primary_key=True, default=uuid.uuid4) - - -@crudable(update=['tags', 'employees']) -@text_length_validation('name', 1, 100) -class User(Base): - name = Column(UnicodeText(), nullable=False, unique=True) - tags = relationship('Tag', cascade='all,delete,delete-orphan', backref='user', passive_deletes=True) - employees = relationship('Account', cascade='all,delete,delete-orphan', passive_deletes=True) - - -@crudable() -class Boss(Base): - name = Column(UnicodeText(), nullable=False, unique=True) - - -@crudable(no_update=['username']) -@regex_validation('username', r'[0-9a-zA-z]+', 'Usernames may only contain alphanumeric characters') -class Account(Base): - user_id = Column(UUID(), ForeignKey('user.id', ondelete='RESTRICT'), nullable=False) - user = relationship(User, overlaps="employees") - username = Column(UnicodeText(), nullable=False, unique=True) - password = Column(UnicodeText(), nullable=False) - - boss_id = Column(UUID(), ForeignKey('boss.id', ondelete='SET NULL'), nullable=True) - boss = relationship(Boss, backref='employees') - - -@crudable(no_update=['name', 'user_id']) -class Tag(Base): - __table_args__ = (UniqueConstraint('user_id', 'name'),) - - name = Column(UnicodeText(), nullable=False) - user_id = Column(UUID(), ForeignKey('user.id', ondelete='CASCADE'), nullable=False) - - -@text_length_validation('mixed_in_attr', 1, 10) -class CrudableMixin(object): - """Test that validation decorators on Mixins work as expected""" - mixed_in_attr = Column(UnicodeText(), default='default string') - extra_data = Column(JSON(), default={}, server_default='{}') - - -@crudable( - data_spec={ - 'date_attr': { - 'date_format': 'Y-M-d', - 'desc': 'this is a manual desc' - }, - 'overridden_desc': { - 'desc': 'this is an overridden desc', - 'validators': { - 'maxLength': 2 - }, - }, - 'manual_attr': { - 'desc': 'this is a manually-specified attribute', - 'name': 'manual_attr', - 'create': True, - 'read': True, - 'type': 'auto', - 'update': True, - 'validators': { - 'maxLength': 2 - } - } - } -) -@text_length_validation('string_model_attr', 2, 100) -@regex_validation('string_model_attr', r'^[A-Za-z0-9\.\_\-]+$', 'test thing') -@text_length_validation('overridden_desc', 1, 100) -@text_length_validation('nonexistant_field', 1, 100) -class CrudableClass(CrudableMixin, Base): - """Testbed class for getting the crud definition for a class that be crudable""" - - string_attr = 'str' - int_attr = 1 - bool_attr = True - float_attr = 1.0 - date_attr = datetime(2011, 1, 1, 0, 0, 0) - string_model_attr = Column(UnicodeText(), default='default string') - int_model_attr = Column(Integer()) - bool_model_attr = Column(Boolean()) - - @property - def settable_property(self): - """this is the docstring""" - return None - - @settable_property.setter - def settable_property(self, thing): - pass - - @hybrid_property - def string_and_int_hybrid_property(self): - """this is the docstring""" - return '{} {}'.format(self.string_model_attr, self.int_model_attr) - - @string_and_int_hybrid_property.expression - def string_and_int_hybrid_property(cls): - return case( - (cls.string_model_attr == None, ''), - (cls.int_model_attr == None, '') - , else_=(cls.string_model_attr + ' ' + cls.int_model_attr)) - - @property - def unsettable_property(self): - """ - this is an epydoc-decorated docstring - - @return: None - """ - return None - - def method(self): - pass - - @property - def overridden_desc(self): - """docstring but not desc""" - return None - - -@crudable() -class BasicClassMixedIn(CrudableMixin, Base): - pass - - -class Session(SessionManager): - engine = sqlalchemy.create_engine('sqlite:////tmp/test_sa.db', poolclass=NullPool) - - class SessionMixin(object): - def user(self, name): - return self.query(User).filter_by(name=name).one() - - def account(self, username): - return self.query(Account).filter_by(username=username).one() - - -def create(model, **params): - with Session() as session: - model = Session.resolve_model(model) - item = model(**params) - session.add(item) - session.commit() - return item.to_dict() - - -def query_from(obj, attr='id'): - return { - '_model': obj['_model'], - 'field': attr, - 'value': obj[attr] - } - - -@pytest.fixture(scope='module') -def init_db(request): - class db: - pass - patch_session(Session, request) - db.turner = create('User', name='Turner') - db.hooch = create('User', name='Hooch') - create('Tag', user_id=db.turner['id'], name='Male') - create('Tag', user_id=db.hooch['id'], name='Male') - db.ninja = create('Tag', user_id=db.turner['id'], name='Ninja') - db.pirate = create('Tag', user_id=db.hooch['id'], name='Pirate') - db.boss = create('Boss', name='Howard Hyde') - db.turner_account = create('Account', username='turner_account', password='password', user_id=db.turner['id'], boss_id=db.boss['id']) - db.hooch_account = create('Account', username='hooch_account', password='password', user_id=db.hooch['id']) - return db - - -@pytest.fixture(autouse=True) -def db(request, init_db): - shutil.copy('/tmp/sideboard.db', '/tmp/sideboard.db.backup') - request.addfinalizer(lambda: shutil.move('/tmp/sideboard.db.backup', '/tmp/sideboard.db')) - return init_db - - -class TestNamingConventions(object): - - @pytest.mark.parametrize('sqltext,expected', [ - ('failed_logins >= 3', 'failed_logins_ge_3'), - ('failed_logins > 3', 'failed_logins_gt_3'), - (' failed_logins = 3 ', 'failed_logins_eq_3'), - ('0123456789012345678901234567890123', '1e4008bc148c5486a3c92b2377fa1c45') - ]) - def test_check_constraint_naming_convention(self, sqltext, expected): - check_constraint = CheckConstraint(sqltext) - table = Table('account', MetaData()) - result = check_constraint_naming_convention(check_constraint, table) - assert result == expected - - -class TestDeclarativeBaseConstructor(object): - def test_default_init(self): - assert User().id # default is applied at initialization instead of on save - - def test_overriden_init(self): - @declarative_base - class WithOverriddenInit(object): - id = Column(UUID(), primary_key=True, default=uuid.uuid4) - - def __init__(self, **kwargs): - self.__dict__.update(kwargs) - - class Foo(WithOverriddenInit): - bar = Column(Boolean()) - - assert Foo().id is None - - @pytest.mark.filterwarnings("ignore:Unmanaged access of declarative attribute") - def test_declarative_base_without_parameters(self): - - @declarative_base - class BaseTest: - pass - - assert BaseTest.__tablename__ == 'base_test' - - @pytest.mark.filterwarnings("ignore:Unmanaged access of declarative attribute") - def test_declarative_base_with_parameters(self): - - @declarative_base(name=str('NameOverride')) - class BaseTest: - pass - - assert BaseTest.__tablename__ == 'name_override' - - -class TestCrudCount(object): - def assert_counts(self, query, **expected): - actual = {count['_label']: count['count'] for count in Session.crud.count(query)} - assert len(expected) == len(actual) - for label, count in expected.items(): - assert count == actual[label] - - def test_subquery(self): - results = Session.crud.count({ - '_model': 'Tag', - 'groupby': ['name'], - 'field': 'user_id', - 'comparison': 'in', - 'value': { - '_model': 'User', - 'select': 'id', - 'field': 'name', - 'value': 'Turner' - } - }) - expected = { - 'Male': 1, - 'Ninja': 1 - } - for result in results[0]['count']: - assert result['count'] == expected[result['name']] - - def test_compound_subquery(self): - query = { - '_model': 'Tag', - 'groupby': ['name'], - 'field': 'user_id', - 'comparison': 'in', - 'value': { - '_model': 'User', - 'select': 'id', - 'or': [{ - 'field': 'name', - 'value': 'Turner' - }, { - 'field': 'name', - 'value': 'Hooch' - }] - } - } - results = Session.crud.count(query) - expected = { - 'Ninja': 1, - 'Pirate': 1, - 'Male': 2 - } - for result in results[0]['count']: - assert result['count'] == expected[result['name']] - - def test_distinct(self): - pytest.skip('Query.distinct(*columns) is postgresql-only') - results = Session.crud.count({'_model': 'Tag'}) - assert results[0]['count'] == 4 - - results = Session.crud.count({ - '_model': 'Tag', - 'distinct': ['name'] - }) - results[0]['count'] == 3 - - def test_groupby(self): - results = Session.crud.count({ - '_model': 'Tag', - 'groupby': ['name'] - }) - expected = { - 'Male': 2, - 'Ninja': 1, - 'Pirate': 1 - } - for result in results[0]['count']: - result['count'] == expected.get(result['name'], 0) - - def test_single_basic_query_string(self): - self.assert_counts('User', User=2) - - def test_single_basic_query_dict(self): - self.assert_counts({'_model': 'User'}, User=2) - - def test_multi_basic_query_string(self): - self.assert_counts(['User', 'Tag'], User=2, Tag=4) - - def test_multi_basic_query_dict(self): - self.assert_counts([{'_model': 'User'}, {'_model': 'Tag'}], User=2, Tag=4) - - def test_single_complex_query(self): - self.assert_counts({'_label': 'HoochCount', '_model': 'User', 'field': 'name', 'value': 'Hooch'}, HoochCount=1) - - def test_multi_complex_query(self): - self.assert_counts([{'_label': 'HoochCount', '_model': 'User', 'field': 'name', 'value': 'Hooch'}, - {'_label': 'MaleCount', '_model': 'Tag', 'field': 'name', 'value': 'Male'}], - HoochCount=1, MaleCount=2) - - def test_multi_complex_query_with_same_models(self): - hooch_query = { - '_model': 'User', - '_label': 'HoochCount', - 'or': [{ - '_model': 'User', - 'field': 'name', - 'value': 'Hooch' - }, { - '_model': 'User', - 'field': 'name', - 'value': 'Hoochert' - }] - } - turner_query = { - '_model': 'User', - '_label': 'TurnerCount', - 'field': 'name', - 'value': 'Turner' - } - all_query = {'_model': 'User'} - - self.assert_counts([hooch_query, turner_query, all_query], User=2, HoochCount=1, TurnerCount=1) - - -class TestCrudRead(object): - def extract(self, models, *fields): - return [{f: m[f] for f in fields if f in m} for m in listify(models)] - - def assert_read_result(self, expected, query, data=None): - expected = listify(expected) - actual = Session.crud.read(query, data) - assert len(expected) == actual['total'] - assert sorted(expected, key=lambda m: m.get('id', m.get('_model'))) \ - == sorted(actual['results'], key=lambda m: m.get('id', m.get('_model'))) - - def test_to_dict_default_attrs(self): - expected = [ - 'bool_attr', - 'bool_model_attr', - 'date_attr', - 'extra_data', - 'float_attr', - 'id', - 'int_attr', - 'int_model_attr', - 'mixed_in_attr', - 'string_attr', - 'string_model_attr'] - actual = CrudableClass.to_dict_default_attrs - assert sorted(expected) == sorted(actual) - - def test_subquery(self): - results = Session.crud.read({ - '_model': 'Tag', - 'field': 'user_id', - 'comparison': 'in', - 'value': { - '_model': 'User', - 'select': 'id', - 'field': 'name', - 'value': 'Turner' - } - }) - assert results['total'] == 2 - assert len(results['results']) == 2 - for tag in results['results']: - assert tag['name'] in ['Ninja', 'Male'] - - def test_compound_subquery(self): - results = Session.crud.read({ - '_model': 'Tag', - 'field': 'user_id', - 'comparison': 'in', - 'value': { - '_model': 'User', - 'select': 'id', - 'or': [{ - 'field': 'name', - 'value': 'Turner' - }, { - 'field': 'name', - 'value': 'Hooch' - }] - } - }) - assert results['total'] == 4 - assert len(results['results']) == 4 - for tag in results['results']: - assert tag['name'] in ['Pirate', 'Ninja', 'Male'] - - def test_distinct(self): - pytest.skip('Query.distinct(*columns) is postgresql-only') - results = Session.crud.read({ - '_model': 'Tag', - 'distinct': ['name'] - }) - assert results['total'] == 3 - assert len(results['results']) == 3 - - results = Session.crud.read({ - '_model': 'Tag', - 'distinct': True - }) - assert results['total'] == 4 - assert len(results['results']) == 4 - - results = Session.crud.read({ - '_model': 'Tag', - 'distinct': ['name', 'id'] - }) - assert results['total'] == 4 - assert len(results['results']) == 4 - - def test_omit_keys_that_are_returned_by_default(self): - results = Session.crud.read({'_model': 'Account'}, { - '_model': False, - 'id': False, - 'username': True, - 'password': False, - 'user': { - '_model': False, - 'id': False, - 'name': True - } - }) - for account in results['results']: - assert '_model' not in account - assert 'id' not in account - assert 'password' not in account - assert '_model' not in account['user'] - assert 'id' not in account['user'] - assert 'username' in account - assert 'name' in account['user'] - - def test_basic_read(self, db): - self.assert_read_result(db.turner, query_from(db.turner, 'id')) - self.assert_read_result(db.turner, query_from(db.turner, 'name')) - - def test_read_with_basic_data_spec(self, db): - result = { - '_model': 'Account', - 'id': db.turner_account['id'], - 'username': 'turner_account' - } - self.assert_read_result(result, query_from(db.turner_account, 'username'), {'username': True}) - self.assert_read_result(result, [query_from(db.turner_account, 'username')], {'username': True}) - self.assert_read_result(result, query_from(db.turner_account, 'username'), [{'username': True}]) - self.assert_read_result(result, [query_from(db.turner_account, 'username')], [{'username': True}]) - self.assert_read_result(result, query_from(db.turner_account, 'username'), ['username']) - self.assert_read_result(result, [query_from(db.turner_account, 'username')], ['username']) - self.assert_read_result(result, query_from(db.turner_account, 'username'), 'username') - self.assert_read_result(result, [query_from(db.turner_account, 'username')], 'username') - - def test_handle_read_with_data_spec_requesting_unreadable_attribute(self, db): - result = { - '_model': 'Account', - 'id': db.turner_account['id'] - } - self.assert_read_result(result, query_from(db.turner_account, 'username'), {'does_not_exist': True}) - self.assert_read_result(result, [query_from(db.turner_account, 'username')], {'does_not_exist': True}) - self.assert_read_result(result, query_from(db.turner_account, 'username'), [{'does_not_exist': True}]) - self.assert_read_result(result, [query_from(db.turner_account, 'username')], [{'does_not_exist': True}]) - self.assert_read_result(result, query_from(db.turner_account, 'username'), ['does_not_exist']) - self.assert_read_result(result, [query_from(db.turner_account, 'username')], ['does_not_exist']) - self.assert_read_result(result, query_from(db.turner_account, 'username'), 'does_not_exist') - self.assert_read_result(result, [query_from(db.turner_account, 'username')], 'does_not_exist') - - def test_read_with_multiple_queries(self, db): - self.assert_read_result([db.turner_account, db.hooch_account], [query_from(db.turner_account), query_from(db.hooch_account)]) - - def test_read_with_multiple_queries_and_one_data_spec(self, db): - expected = self.extract([db.turner_account, db.hooch_account], '_model', 'id', 'username') - self.assert_read_result(expected, [query_from(db.turner_account), query_from(db.hooch_account)], {'username': True}) - self.assert_read_result(expected, [query_from(db.turner_account), query_from(db.hooch_account)], [{'username': True}]) - self.assert_read_result(expected, [query_from(db.turner_account), query_from(db.hooch_account)], ['username']) - self.assert_read_result(expected, [query_from(db.turner_account), query_from(db.hooch_account)], 'username') - - def test_read_with_ored_query_and_one_data_spec(self, db): - expected = self.extract([db.turner_account, db.hooch_account], '_model', 'id', 'username') - query = { - '_model': 'Account', - 'or': [{ - 'field': 'username', - 'value': 'turner_account' - }, { - 'field': 'username', - 'value': 'hooch_account' - }] - } - self.assert_read_result(expected, query, {'username': True}) - self.assert_read_result(expected, query, [{'username': True}]) - self.assert_read_result(expected, query, ['username']) - self.assert_read_result(expected, query, 'username') - self.assert_read_result(expected, [query], {'username': True}) - self.assert_read_result(expected, [query], [{'username': True}]) - self.assert_read_result(expected, [query], 'username') - self.assert_read_result(expected, [query], ['username']) - - def test_read_with_two_models(self, db): - query = [query_from(db.turner), query_from(db.hooch_account)] - self.assert_read_result([db.turner, db.hooch_account], query) - - def test_read_with_two_models_and_one_data_spec(self, db): - query = [query_from(db.turner), query_from(db.pirate)] - expected = self.extract([db.turner, db.pirate], '_model', 'id', 'name') - self.assert_read_result(expected, query, {'name': True}) - self.assert_read_result(expected, query, [{'name': True}]) - self.assert_read_result(expected, query, ['name']) - self.assert_read_result(expected, query, 'name') - - def test_read_with_two_models_and_two_data_specs(self, db): - query = [query_from(db.turner_account), query_from(db.pirate)] - expected = self.extract(db.turner_account, '_model', 'id', 'username') + self.extract(db.pirate, '_model', 'id', 'user_id') - self.assert_read_result(expected, query, [['username'], ['user_id']]) - self.assert_read_result(expected, query, [{'username': True}, ['user_id']]) - self.assert_read_result(expected, query, [['username'], {'user_id': True}]) - self.assert_read_result(expected, query, [{'username': True}, {'user_id': True}]) - - def test_handle_bad_query(self): - pytest.raises(CrudException, Session.crud.read, {'field': 'last_name'}) - - def test_handle_illegal_read(self, db): - results = Session.crud.read(query_from(db.turner), {'__repr__': True}) - assert '__repr__' not in results['results'][0] - - def test_handle_read_on_nonexistant_attribute(self, db): - results = Session.crud.read(query_from(db.turner), {'does_not_exist': True}) - assert 'does_not_exist' not in results['results'][0] - - -class TestCrudUpdate(object): - def test_single_update(self): - Session.crud.update({'_model': 'Account', 'field': 'username', 'value': 'turner_account'}, {'password': 'changing'}) - with Session() as session: - assert 'password' == session.account('hooch_account').password - assert 'changing' == session.account('turner_account').password - - def test_multiple_updates(self): - Session.crud.update({'_model': 'Account'}, {'password': 'foobar'}) - with Session() as session: - for account in session.query(Account).all(): - assert account.password == 'foobar' - - def test_nested_json(self): - Session.crud.update({'_model': 'Account', 'username': 'turner_account'}, { - 'password': 'barbaz', - 'user': {'name': 'Turner the Awesome'} - }) - with Session() as session: - assert 'barbaz' == session.account('turner_account').password - assert 'Turner the Awesome' == session.account('turner_account').user.name - - def test_handle_bad_relation_type(self, db): - pytest.raises(CrudException, Session.crud.update, query_from(db.turner), {'employees': 'not a dict or sequence of dicts'}) - - def test_create_foreign_relation_with_one_spec(self): - Session.crud.update({'_model': 'Account'}, {'user': {'name': 'New User'}}) - with Session() as session: - assert 3 == len(session.query(User).all()) - assert 'New User' == session.account('turner_account').user.name - assert 'New User' == session.account('hooch_account').user.name - - def test_create_foreign_relation_with_multiple_specs(self, db): - Session.crud.update([query_from(db.turner_account), query_from(db.hooch_account)], 2 * [{'user': {'name': 'New User'}}]) - with Session() as session: - assert 3 == len(session.query(User).all()) - assert 'New User' == session.account('turner_account').user.name - assert 'New User' == session.account('hooch_account').user.name - - def test_adding_and_removing_tag(self, db): - Session.crud.update(query_from(db.turner), {'tags': []}) - with Session() as session: - assert not session.user('Turner').tags - assert 2 == session.query(Tag).count() - - Session.crud.update(query_from(db.turner), {'tags': [{'name': 'New'}]}) - with Session() as session: - assert 3 == session.query(Tag).count() - [new] = session.user('Turner').tags - assert 'New' == new.name - - def test_removing_tags_with_none(self, db): - Session.crud.update(query_from(db.turner), {'tags': None}) - with Session() as session: - assert not session.user('Turner').tags - assert 2 == session.query(Tag).count() - - def test_editing_account_from_user(self, db): - Session.crud.update(query_from(db.turner), { - 'employees': [{ - 'username': 'turner_account', - 'password': 'newpass' - }] - }) - with Session() as session: - assert 2 == session.query(Account).count() - assert 'newpass' == session.account('turner_account').password - - def test_unset_nullable_foreign_relation(self, db): - Session.crud.update(query_from(db.turner_account), {'boss': None}) - with Session() as session: - assert 1 == session.query(Boss).count() - assert session.account('turner_account').boss is None - - def test_unset_nullable_foreign_relation_from_parent_with_none(self, db): - Session.crud.update(query_from(db.boss), {'employees': None}) - with Session() as session: - assert 1 == session.query(Boss).count() - assert session.account('turner_account').boss is None - - def test_unset_nullable_foreign_relation_from_parent_with_empty_list(self, db): - Session.crud.update(query_from(db.boss), {'employees': []}) - with Session() as session: - assert 1 == session.query(Boss).count() - assert session.account('turner_account').boss is None - - def test_update_nonexistent_attribute(self, db): - pytest.raises(Exception, Session.crud.update, query_from(db.turner), {'does_not_exist': 'foo'}) - - def test_update_nonupdatable_attribute(self, db): - pytest.raises(Exception, Session.crud.update, query_from(db.turner_account), {'username': 'foo'}) - - -class TestCrudDelete(object): - def test_delete_cascades_to_tags(self, db): - Session.crud.delete(query_from(db.turner_account)) - Session.crud.delete(query_from(db.turner)) - with Session() as session: - assert 1 == session.query(Account).count() - assert 2 == session.query(Tag).count() - - def test_delete_by_id(self, db): - Session.crud.delete({'_model': 'Account', 'field': 'id', 'value': db.turner_account['id']}) - with Session() as session: - assert 1 == session.query(Account).count() - pytest.raises(Exception, session.account, 'turner_account') - - def test_multiple_deletes_by_id(self): - Session.crud.delete([ - {'_model': 'Account', 'field': 'username', 'value': 'turner_account'}, - {'_model': 'Tag', 'field': 'name', 'value': 'Pirate'} - ]) - with Session() as session: - assert 3 == session.query(Tag).count() - assert 1 == session.query(Account).count() - pytest.raises(Exception, session.account, 'turner_account') - - def test_empty_delete(self): - assert 0 == Session.crud.delete([]) - - def test_delete_without_results(self): - assert 0 == Session.crud.delete({'_model': 'Account', 'field': 'username', 'value': 'does_not_exist'}) - - def test_non_single_delete(self): - pytest.raises(CrudException, Session.crud.delete, {'_model': 'Account'}) - pytest.raises(CrudException, Session.crud.delete, {'_model': 'Tag', 'field': 'name', 'value': 'Male'}) - - -class TestCrudCreate(object): - def test_basic_create(self, db): - Session.crud.create({ - '_model': 'Tag', - 'name': 'New', - 'user_id': db.turner['id'] - }) - with Session() as session: - assert {'New', 'Ninja', 'Male'} == {tag.name for tag in session.user('Turner').tags} - - def test_deeply_nested_create(self): - Session.crud.create({ - '_model': 'Account', - 'username': 'new', - 'password': 'createdpass', - 'user': { - 'name': 'New', - 'tags': [{'name': 'Recent'}, {'name': 'Male'}] - } - }) - with Session() as session: - new = session.account('new') - assert 'new' == new.username - assert 'New' == new.user.name - assert {'Recent', 'Male'} == {tag.name for tag in new.user.tags} - - def test_duplicate_create(self): - pytest.raises(CrudException, Session.crud.create, {'_model': 'User', 'name': 'Turner'}) - - def test_create_two_objects(self): - Session.crud.create([{ - '_model': 'Boss', - 'name': 'NewCo' - }, { - '_model': 'User', - 'name': 'New Guy' - }]) - with Session() as session: - assert 3 == session.query(User).count() - assert 2 == session.query(Boss).count() - - def test_handle_bad_spec_no_model(self): - pytest.raises(CrudException, Session.crud.create, {'name': 'Turner'}) - - def test_setting_null_on_unnullable_attributes(self): - pytest.raises(CrudException, Session.crud.create, {'_model': 'User', 'name': None}) - - def test_set_foreign_key_relations_using_string_id(self, db): - Session.crud.create({ - '_model': 'Account', - 'user_id': db.turner['id'], - 'username': 'turner_account_other_users', - 'password': 'password' - }) - with Session() as session: - assert 2 == len(session.user('Turner').employees) - - -class TestCrudValidations(object): - def test_length(self): - pytest.raises(CrudException, Session.crud.update, {'_model': 'User'}, {'name': ''}) - pytest.raises(CrudException, Session.crud.update, {'_model': 'User'}, {'name': 'x' * 101}) - - def test_regex(self): - pytest.raises(CrudException, Session.crud.update, {'_model': 'Account'}, {'username': '!@#'}) - - -class TestNormalizeQuery(object): - def test_one_string(self): - results = normalize_query('Human') - assert results == [{'_model': 'Human', '_label': 'Human'}] - - def test_one_string_in_a_list(self): - results = normalize_query(['Human']) - assert results == [{'_model': 'Human', '_label': 'Human'}] - - def test_two_strings(self): - results = normalize_query(['Human', 'Proxy']) - assert results == [{'_model': 'Human', '_label': 'Human'}, {'_model': 'Proxy', '_label': 'Proxy'}] - results = normalize_query(['Proxy', 'Human']) - assert results == [{'_model': 'Proxy', '_label': 'Proxy'}, {'_model': 'Human', '_label': 'Human'}] - - def test_one_dict(self): - results = normalize_query({'_model': 'Human'}) - assert results == [{'_model': 'Human'}] - - def test_one_dict_in_a_list(self): - results = normalize_query([{'_model': 'Human'}]) - assert results == [{'_model': 'Human'}] - - def test_two_dicts(self): - results = normalize_query([{'_model': 'Human'}, {'_model': 'Proxy'}]) - assert results == [{'_model': 'Human'}, {'_model': 'Proxy'}] - results = normalize_query([{'_model': 'Proxy'}, {'_model': 'Human'}]) - assert results == [{'_model': 'Proxy'}, {'_model': 'Human'}] - - def test_or_clause(self): - results = normalize_query([{'_model': 'Human', 'or': [{'_model': 'Human', 'field': 'nickname', 'value': 'Johnny'}, {'_model': 'Human', 'field': 'nickname', 'value': 'Winny'}]}, {'_model': 'Proxy'}]) - assert results == [{'_model': 'Human', 'or': [{'_model': 'Human', 'field': 'nickname', 'value': 'Johnny'}, {'_model': 'Human', 'field': 'nickname', 'value': 'Winny'}]}, {'_model': 'Proxy'}] - - def test_and_clause_push_down_supermodel(self): - results = normalize_query([{'_model': 'Human', 'or': [{'field': 'nickname', 'value': 'Johnny'}, {'field': 'nickname', 'value': 'Winny'}]}, {'_model': 'Proxy'}]) - assert results == [{'_model': 'Human', 'or': [{'_model': 'Human', 'field': 'nickname', 'value': 'Johnny'}, {'_model': 'Human', 'field': 'nickname', 'value': 'Winny'}]}, {'_model': 'Proxy'}] - - def test_or_clause_no_model(self): - results = normalize_query([{'or': [{'_model': 'Human'}, {'_model': 'Human', 'field': 'nickname', 'value': 'Johnny'}]}, {'_model': 'Proxy'}]) - assert results == [{'_model': 'Human', 'or': [{'_model': 'Human'}, {'_model': 'Human', 'field': 'nickname', 'value': 'Johnny'}]}, {'_model': 'Proxy'}] - - def test_and_clause(self): - results = normalize_query([{'_model': 'Human', 'and': [{'_model': 'Human', 'field': 'nickname', 'value': 'Johnny'}, {'_model': 'Human', 'field': 'nickname', 'value': 'Winny'}]}, {'_model': 'Proxy'}]) - assert results == [{'_model': 'Human', 'and': [{'_model': 'Human', 'field': 'nickname', 'value': 'Johnny'}, {'_model': 'Human', 'field': 'nickname', 'value': 'Winny'}]}, {'_model': 'Proxy'}] - - def test_and_clause_no_model(self): - results = normalize_query([{'and': [{'_model': 'Human'}, {'_model': 'Human', 'field': 'nickname', 'value': 'Johnny'}]}, {'_model': 'Proxy'}]) - assert results == [{'_model': 'Human', 'and': [{'_model': 'Human'}, {'_model': 'Human', 'field': 'nickname', 'value': 'Johnny'}]}, {'_model': 'Proxy'}] - - def test_fails_or_clause_list_of_lists(self): - pytest.raises(ValueError, normalize_query, [{'or': [[], []]}, {'_model': 'Proxy', '_label': 'Proxy'}]) - - def test_fails_none(self): - pytest.raises(ValueError, normalize_query, None) - - def test_fails_list_of_lists(self): - pytest.raises(ValueError, normalize_query, [[], []]) - - def test_fails_one_empty_dict(self): - pytest.raises(ValueError, normalize_query, {}) - - def test_fails_one_dict_no_model(self): - pytest.raises(ValueError, normalize_query, {'field': 'nickname', 'value': 'Johnny'}) - - def test_fails_one_empty_dict_in_a_list(self): - pytest.raises(ValueError, normalize_query, [{}]) - - def test_fails_one_dict_no_model_in_a_list(self): - pytest.raises(ValueError, normalize_query, [{'field': 'nickname', 'value': 'Johnny'}]) - - def test_fails_two_dicts_one_without_model(self): - pytest.raises(ValueError, normalize_query, [{'_model': 'Proxy'}, {'field': 'nickname', 'value': 'Johnny'}]) - - def test_fails_and_clause_no_model(self): - pytest.raises(ValueError, normalize_query, [{'and': [{'field': 'nickname', 'value': 'Johnny'}, {'field': 'nickname', 'value': 'Winny'}]}, {'_model': 'Proxy'}]) - - def test_fails_or_clause_no_model(self): - pytest.raises(ValueError, normalize_query, [{'or': [{'field': 'nickname', 'value': 'Johnny'}, {'field': 'nickname', 'value': 'Winny'}]}, {'_model': 'Proxy'}]) - - def test_fails_and_clause_list_of_lists(self): - pytest.raises(ValueError, normalize_query, [{'and': [[], []]}, {'_model': 'Proxy'}]) - - def test_fails_and_clause_with_model_list_of_lists(self): - pytest.raises(ValueError, normalize_query, [{'_model': 'Human', 'and': [[], []]}, {'_model': 'Proxy'}]) - - def test_fails_or_clause_with_model_list_of_lists(self): - pytest.raises(ValueError, normalize_query, [{'_model': 'Human', 'or': [[], []]}, {'_model': 'Proxy'}]) - - -class TestCollectModels(object): - def assert_models(self, *args): - expected_models = set(args[:-1]) - actual_models = Session.crud._collect_models(args[-1]) - assert expected_models == actual_models - - def test_single(self): - self.assert_models(User, {'_model': 'User'}) - - def test_multiple(self): - self.assert_models(User, Account, [{'_model': 'User'}, {'_model': 'Account'}]) - - def test_foreign_key(self): - self.assert_models(Account, User, {'_model': 'Account', 'field': 'user.name'}) - - def test_nested_keys(self): - self.assert_models(Account, User, Tag, {'_model': 'Account', 'field': 'user.name.tags'}) - - -class TestCrudableClass(object): - expected_crud_spec = { - 'fields': { - 'id': { - 'name': 'id', - 'type': 'auto', - 'create': True, - 'read': True, - 'update': False, - }, - 'string_attr': { - 'name': 'string_attr', - 'type': 'string', - 'create': False, - 'read': True, - 'update': False, - 'defaultValue': 'str', - }, - 'int_attr': { - 'name': 'int_attr', - 'type': 'int', - 'create': False, - 'read': True, - 'update': False, - 'defaultValue': 1, - }, - 'extra_data': { - 'create': True, - 'name': 'extra_data', - 'read': True, - 'type': 'auto', - 'update': True - }, - 'bool_attr': { - 'name': 'bool_attr', - 'type': 'boolean', - 'create': False, - 'read': True, - 'update': False, - 'defaultValue': True, - }, - 'float_attr': { - 'name': 'float_attr', - 'type': 'float', - 'create': False, - 'read': True, - 'update': False, - 'defaultValue': 1.0, - }, - 'date_attr': { - 'name': 'date_attr', - 'type': 'date', - 'create': False, - 'read': True, - 'update': False, - 'desc': 'this is a manual desc', - 'defaultValue': datetime(2011, 1, 1, 0, 0), - 'date_format': 'Y-M-d', - }, - 'string_model_attr': { - 'name': 'string_model_attr', - 'type': 'string', - 'create': True, - 'read': True, - 'update': True, - 'defaultValue': 'default string', - 'validators': { - u'maxLength': 100, - u'maxLengthText': u'The maximum length of this field is {0}.', - u'minLength': 2, - u'minLengthText': u'The minimum length of this field is {0}.', - u'regexString': u'^[A-Za-z0-9\\.\\_\\-]+$', - u'regexText': u'test thing'} - }, - 'mixed_in_attr': { - 'create': True, - 'defaultValue': 'default string', - 'name': 'mixed_in_attr', - 'read': True, - 'type': 'string', - 'update': True, - 'validators': { - 'maxLength': 10, - 'maxLengthText': 'The maximum length of this field is {0}.', - 'minLength': 1, - 'minLengthText': 'The minimum length of this field is {0}.' - } - }, - 'bool_model_attr': { - 'name': 'bool_model_attr', - 'type': 'boolean', - 'create': True, - 'read': True, - 'update': True, - }, - 'int_model_attr': { - 'name': 'int_model_attr', - 'type': 'int', - 'create': True, - 'read': True, - 'update': True, - }, - 'settable_property': { - 'desc': 'this is the docstring', - 'name': 'settable_property', - 'type': 'auto', - 'create': True, - 'read': True, - 'update': True, - }, - 'unsettable_property': { - 'desc': 'this is an epydoc-decorated docstring', - 'name': 'unsettable_property', - 'type': 'auto', - 'create': False, - 'read': True, - 'update': False, - }, - 'manual_attr': { - 'name': 'manual_attr', - 'type': 'auto', - 'create': True, - 'read': True, - 'update': True, - 'desc': 'this is a manually-specified attribute', - 'validators': { - 'maxLength': 2 - } - }, - 'overridden_desc': { - 'create': False, - 'desc': 'this is an overridden desc', - 'name': 'overridden_desc', - 'read': True, - 'type': 'auto', - 'update': False, - 'validators': { - 'maxLength': 2, - 'maxLengthText': 'The maximum length of this field is {0}.', - 'minLength': 1, - 'minLengthText': 'The minimum length of this field is {0}.', - } - } - } - } - - def test_crud_spec(self): - assert self.expected_crud_spec == CrudableClass._crud_spec - - def test_basic_crud_spec(self): - expected_basic = {'fields': {k: self.expected_crud_spec['fields'][k] - for k in ('id', 'mixed_in_attr', 'extra_data')}} - assert expected_basic == BasicClassMixedIn._crud_spec - - def test_handle_no_crud_spec_attribute(self): - with pytest.raises(AttributeError): - object._crud_spec - - -def test_collect_ancestor_classes(): - classes = collect_ancestor_classes(Account) - for cls in [Account, Base, object]: - assert cls in classes - - classes = collect_ancestor_classes(Account, object) - for cls in [Account, Base]: - assert cls in classes - for cls in [object]: - assert cls not in classes - - classes = collect_ancestor_classes(Account, Base) - for cls in [Account]: - assert cls in classes - for cls in [Base, object]: - assert cls not in classes - - -def test_get_models(): - def assert_models(xs, models): - assert set(xs) == Session.crud._get_models(models) - - assert_models([], 0) - assert_models([], {}) - assert_models([], []) - assert_models([], '') - assert_models([], None) - assert_models([], {'_model': 0}) - assert_models([], {'_model': {}}) - assert_models([], {'_model': []}) - assert_models([], {'_model': None}) - assert_models(['User'], {'_model': 'User'}) - assert_models(['User'], [{'_model': 'User'}]) - assert_models(['User'], ({'_model': 'User'},)) - assert_models(['User'], {'foo': {'_model': 'User'}}) diff --git a/sideboard/tests/test_server.py b/sideboard/tests/test_server.py deleted file mode 100644 index 946d598..0000000 --- a/sideboard/tests/test_server.py +++ /dev/null @@ -1,151 +0,0 @@ -from __future__ import unicode_literals -import json -import socket -from uuid import uuid4 -from time import sleep -from random import randrange -from unittest import TestCase - -import six -from six.moves.queue import Queue, Empty -from six.moves.urllib.parse import urlparse, urlencode, parse_qsl - -import pytest -import cherrypy -import requests -from rpctools.jsonrpc import ServerProxy -from ws4py.server.cherrypyserver import WebSocketPlugin - -import sideboard.websockets -from sideboard.lib import log, config, subscribes, notifies, notify, services, cached_property, WebSocket -from sideboard.tests import service_patcher, config_patcher, get_available_port -from sideboard.tests.test_sa import Session - - -if config['cherrypy']['server.socket_port'] == 0: - available_port = get_available_port() - - # The config is updated in two places because by the time this code is - # executed, cherrypy.config will already be populated with the values from - # our config file. The configuration will already be living in two places, - # each of which must be updated. - config['cherrypy']['server.socket_port'] = available_port - cherrypy.config.update({'server.socket_port': available_port}) - - -class SideboardServerTest(TestCase): - port = config['cherrypy']['server.socket_port'] - jsonrpc_url = 'http://127.0.0.1:{}/jsonrpc'.format(port) - jsonrpc = ServerProxy(jsonrpc_url) - - rsess_username = 'unit_tests' - - @staticmethod - def assert_can_connect_to_localhost(port): - for i in range(50): - try: - socket.create_connection(('127.0.0.1', port)).close() - except Exception as e: - sleep(0.1) - else: - break - else: - raise e - - @classmethod - def start_cherrypy(cls): - config['thread_wait_interval'] = 0.1 - - class Root(object): - @cherrypy.expose - def index(self): - cherrypy.session['username'] = cls.rsess_username - return cls.rsess_username - - cherrypy.tree.apps.pop('/mock_login', None) - cherrypy.tree.mount(Root(), '/mock_login') - - cherrypy.config.update({'engine.autoreload_on': False}) - cherrypy.engine.start() - cherrypy.engine.wait(cherrypy.engine.states.STARTED) - cls.assert_can_connect_to_localhost(cls.port) - - @classmethod - def stop_cherrypy(cls): - cherrypy.engine.stop() - cherrypy.engine.wait(cherrypy.engine.states.STOPPED) - cherrypy.engine.state = cherrypy.engine.states.EXITING - - # ws4py does not support stopping and restarting CherryPy - sideboard.websockets.websocket_plugin.unsubscribe() - sideboard.websockets.websocket_plugin = WebSocketPlugin(cherrypy.engine) - sideboard.websockets.websocket_plugin.subscribe() - - @classmethod - def setUpClass(cls): - super(SideboardServerTest, cls).setUpClass() - cls.start_cherrypy() - - @classmethod - def tearDownClass(cls): - cls.stop_cherrypy() - super(SideboardServerTest, cls).tearDownClass() - - def wait_for(self, func, *args, **kwargs): - for i in range(50): - cherrypy.engine.publish('main') # since our unit tests don't call cherrypy.engine.block, we must publish this event manually - try: - result = func(*args, **kwargs) - assert result or result is None - except: - sleep(0.1) - else: - break - else: - raise AssertionError('wait timed out') - - def wait_for_eq(self, target, func, *args, **kwargs): - try: - self.wait_for(lambda: target == func(*args, **kwargs)) - except: - raise AssertionError('{!r} != {!r}'.format(target, func(*args, **kwargs))) - - def wait_for_ne(self, target, func, *args, **kwargs): - try: - self.wait_for(lambda: target != func(*args, **kwargs)) - except: - raise AssertionError('{!r} == {!r}'.format(target, func(*args, **kwargs))) - - @cached_property - def rsess(self): - rsess = requests.Session() - rsess.trust_env = False - self._get(rsess, '/mock_login') - return rsess - - def url(self, path, **query_params): - params = dict(parse_qsl(urlparse(path).query)) - params.update(query_params) - url = 'http://127.0.0.1:{}{}'.format(self.port, urlparse(path).path) - if params: - url += '?' + urlencode(params) - return url - - def _get(self, rsess, path, **params): - return rsess.get(self.url(path, **params)) - - def get(self, path, **params): - return self._get(self.rsess, path, **params).content - - def get_json(self, path, **params): - return self._get(self.rsess, path, **params).json() - - def assert_no_response(self): - pytest.raises(Empty, self.next) - - def subscribe(self, **params): - params.setdefault('client', self.client) - return self.call(**params) - - def unsubscribe(self, client=None): - self.call(action='unsubscribe', client=client or self.client) diff --git a/sideboard/tests/test_websocket.py b/sideboard/tests/test_websocket.py deleted file mode 100644 index e6bb5b6..0000000 --- a/sideboard/tests/test_websocket.py +++ /dev/null @@ -1,216 +0,0 @@ -from __future__ import unicode_literals - -import pytest -from mock import Mock, ANY - -import ws4py.websocket - -from sideboard.websockets import WebSocketDispatcher -from sideboard.lib import log, WebSocket, threadlocal, stopped -from sideboard.tests import config_patcher - - -@pytest.fixture(autouse=True) -def reset_stopped(): - stopped.clear() - - -@pytest.fixture -def ws(monkeypatch): - ws = WebSocket(connect_immediately=False) - monkeypatch.setattr(log, 'warning', Mock()) - ws._send = Mock() - ws._next_id = lambda prefix: 'xxx' - return ws - - -@pytest.fixture -def orig_ws(monkeypatch): - monkeypatch.setattr(ws4py.websocket.WebSocket, '__init__', Mock(return_value=None)) - monkeypatch.setattr(WebSocketDispatcher, 'check_authentication', Mock(return_value={'username': 'mock_username'})) - return WebSocketDispatcher() - - -def test_subscribe_basic(ws): - callback = Mock() - assert 'xxx' == ws.subscribe(callback, 'foo.bar', 'x', 'y') - registered = ws._callbacks['xxx'].copy() - del registered['errback'] - assert registered == { - 'client': 'xxx', - 'callback': callback, - 'method': 'foo.bar', - 'params': ('x', 'y') - } - ws._send.assert_called_with(method='foo.bar', params=('x', 'y'), client='xxx') - assert not log.warning.called - - -def test_subscribe_advanced(ws): - callback, errback = Mock(), Mock() - request = { - 'client': 'yyy', - 'callback': callback, - 'errback': errback - } - assert 'yyy' == ws.subscribe(request, 'foo.bar', 'x', 'y') - assert ws._callbacks['yyy'] == { - 'client': 'yyy', - 'callback': callback, - 'errback': errback, - 'method': 'foo.bar', - 'params': ('x', 'y') - } - ws._send.assert_called_with(method='foo.bar', params=('x', 'y'), client='yyy') - assert not log.warning.called - - -def test_subscribe_error(ws): - ws._send = Mock(side_effect=Exception) - ws.subscribe(Mock(), 'foo.bar') - assert 'xxx' in ws._callbacks - assert log.warning.called - - -def test_subscribe_paramback(ws): - paramback = lambda: (5, 6) - callback, errback = Mock(), Mock() - request = { - 'client': 'yyy', - 'callback': callback, - 'errback': errback, - 'paramback': paramback - } - assert 'yyy' == ws.subscribe(request, 'foo.bar') - assert ws._callbacks['yyy'] == { - 'client': 'yyy', - 'callback': callback, - 'errback': errback, - 'paramback': paramback, - 'method': 'foo.bar', - 'params': (5, 6) - } - ws._send.assert_called_with(method='foo.bar', params=(5, 6), client='yyy') - assert not log.warning.called - - -def test_unsubscribe(ws): - ws._callbacks['xxx'] = {} - ws.unsubscribe('xxx') - assert 'xxx' not in ws._callbacks - ws._send.assert_called_with(client='xxx', action='unsubscribe') - - -@pytest.fixture -def returner(ws): - ws._send = Mock(side_effect=lambda **kwargs: ws._callbacks['xxx']['callback'](123)) - return ws - - -@pytest.fixture -def errorer(ws): - ws._send = Mock(side_effect=lambda **kwargs: ws._callbacks['xxx']['errback']('fail')) - return ws - - -def test_call_raises_on_send_error(ws): - ws._send = Mock(side_effect=Exception) - pytest.raises(Exception, ws.call, 'foo.bar') - assert 'xxx' not in ws._callbacks - - -def test_call_returns_value(returner): - assert 123 == returner.call('foo.bar') - assert 'xxx' not in returner._callbacks - - -def test_call_error(errorer): - pytest.raises(Exception, errorer.call, 'foo.bar') - assert 'xxx' not in errorer._callbacks - - -def test_call_timeout(ws, config_patcher, monkeypatch): - monkeypatch.setattr(stopped, 'is_set', Mock(return_value=False)) - config_patcher(1, 'ws.call_timeout') - pytest.raises(Exception, ws.call, 'foo.bar') - assert 'xxx' not in ws._callbacks - assert 9 <= stopped.is_set.call_count <= 11 - - -def test_call_stopped_set(ws, request, monkeypatch): - request.addfinalizer(stopped.clear) - stopped.set() - pytest.raises(Exception, ws.call, 'foo.bar') - - -@pytest.fixture -def refirer(ws): - ws._callbacks.update({ - 'xxx': {'method': 'x.x', 'params': (1, 2), 'client': 'xxx'}, - 'yyy': {'method': 'y.y', 'params': (3, 4)}, - 'zzz': {'method': 'z.z', 'params': (5, 6), 'client': 'zzz'} - }) - return ws - - -def test_refire(refirer): - refirer._refire_subscriptions() - assert refirer._send.call_count == 2 - refirer._send.assert_any_call(method='x.x', params=(1, 2), client='xxx') - refirer._send.assert_any_call(method='z.z', params=(5, 6), client='zzz') - - -def test_refire_error(refirer): - refirer._send = Mock(side_effect=Exception) - refirer._refire_subscriptions() - assert refirer._send.call_count == 1 - - -def test_make_method_caller(ws): - ws.call = Mock() - func = ws.make_caller('foo.bar') - func(1, 2) - ws.call.assert_called_with('foo.bar', 1, 2) - - -def test_make_subscription_caller(ws, orig_ws): - threadlocal.reset(message={'client': 'xxx'}, websocket=orig_ws) - func = ws.make_caller('foo.bar') - assert func(1, 2) == orig_ws.NO_RESPONSE - ws._send.assert_called_with(method='foo.bar', params=(1, 2), client=ANY) - - -def test_make_updated_subscription_caller(ws, orig_ws): - threadlocal.reset(message={'client': 'xxx'}, websocket=orig_ws) - func = ws.make_caller('foo.bar') - assert func is ws.make_caller('foo.baz') - assert func.method == 'foo.baz' - - -def test_make_subscription_unsubscribe(ws, orig_ws): - ws.unsubscribe = Mock() - ws._next_id = Mock(return_value='xxx') - threadlocal.reset(message={'client': 'yyy'}, websocket=orig_ws) - ws.make_caller('foo.bar').unsubscribe() - ws.unsubscribe.assert_called_with('xxx') - - -def test_preprocess_call(ws, returner): - ws.preprocess = lambda method, params: ['mock_modified_params'] - assert 123 == ws.call('foo.bar') - ws._send.assert_called_with(method='foo.bar', params=['mock_modified_params'], callback='xxx') - - -def test_preprocess_subscribe(ws): - ws.preprocess = lambda method, params: ['mock_modified_params'] - callback = Mock() - assert 'xxx' == ws.subscribe(callback, 'foo.bar') - registered = ws._callbacks['xxx'].copy() - del registered['errback'] - assert registered == { - 'client': 'xxx', - 'callback': callback, - 'method': 'foo.bar', - 'params': ['mock_modified_params'] - } - ws._send.assert_called_with(method='foo.bar', params=['mock_modified_params'], client='xxx') diff --git a/sideboard/tests/test_websocket_dispatcher.py b/sideboard/tests/test_websocket_dispatcher.py deleted file mode 100644 index 874e2af..0000000 --- a/sideboard/tests/test_websocket_dispatcher.py +++ /dev/null @@ -1,486 +0,0 @@ -from __future__ import unicode_literals -from threading import RLock -from collections import namedtuple - -import pytest -from mock import Mock, ANY -from ws4py.websocket import WebSocket - -from sideboard.lib import log, services, subscribes, threadlocal -from sideboard.websockets import WebSocketDispatcher, responder, threadlocal -from sideboard.tests import service_patcher -from sideboard.tests.test_websocket import ws - -mock_session_data = {'username': 'mock_user', 'user_id': 'mock_id'} -mock_header_data = {'REMOTE_USER': 'mock_user', 'REMOTE_USER_ID': 'mock_id'} - - -def mock_wsd(): - wsd = Mock() - wsd.is_closed = False - return wsd - - -@pytest.fixture(autouse=True) -def cleanup(): - yield - threadlocal.reset() - WebSocketDispatcher.instances.clear() - - -@pytest.fixture -def wsd(monkeypatch): - WebSocketDispatcher.instances.clear() - monkeypatch.setattr(WebSocket, 'send', Mock()) - monkeypatch.setattr(WebSocket, 'closed', Mock()) - monkeypatch.setattr(WebSocketDispatcher, 'is_closed', False) - monkeypatch.setattr(WebSocketDispatcher, 'check_authentication', lambda cls: mock_session_data) - monkeypatch.setattr(WebSocketDispatcher, 'fetch_headers', lambda cls: mock_header_data) - return WebSocketDispatcher(None) - - -@pytest.fixture -def ws1(): return mock_wsd() - - -@pytest.fixture -def ws2(): return mock_wsd() - - -@pytest.fixture -def ws3(): return mock_wsd() - - -@pytest.fixture -def ws4(): - class RaisesError: - is_closed = False - unsubscribe_all = Mock() - trigger = Mock(side_effect=Exception) - return RaisesError - - -@pytest.fixture(autouse=True) -def subscriptions(request, wsd, ws1, ws2, ws3, ws4): - def reset_subscriptions(): - WebSocketDispatcher.subscriptions.clear() - reset_subscriptions() - request.addfinalizer(reset_subscriptions) - WebSocketDispatcher.subscriptions['foo'][wsd]['client-0'].add('callback-0') - WebSocketDispatcher.subscriptions['bar'][wsd]['client-0'].add(None) - WebSocketDispatcher.subscriptions['foo'][ws1]['client-1'].add(None) - WebSocketDispatcher.subscriptions['bar'][ws1]['client-1'].add('callback-1') - WebSocketDispatcher.subscriptions['foo'][ws2]['client-2'].add(None) - WebSocketDispatcher.subscriptions['baz'][ws3]['client-3'].add(None) - WebSocketDispatcher.subscriptions['baf'][ws4]['client-3'].add(None) - - -def test_instances(wsd): - assert WebSocketDispatcher.instances == {wsd} - wsd.closed('code', 'reason') - assert WebSocketDispatcher.instances == set() - - -def test_get_all_subscribed(wsd, ws1, ws2, ws3, ws4): - assert WebSocketDispatcher.get_all_subscribed() == {wsd, ws1, ws2, ws3, ws4} - - -class TestBroadcast(object): - def test_basic_broadcast(self, ws1, ws2): - WebSocketDispatcher.broadcast('bar', trigger='manual') - ws1.trigger.assert_called_with(client='client-1', callback='callback-1', trigger='manual') - assert not ws2.trigger.called - assert not ws1.unsubscribe_all.called and not ws2.unsubscribe_all.called - - def test_broadcast_with_originating_client(self, ws1, ws2): - WebSocketDispatcher.broadcast('foo', originating_client='client-1') - assert ws2.trigger.called and not ws1.trigger.called - - def test_multi_broadcast(self, ws1, ws2, ws3, ws4): - WebSocketDispatcher.broadcast(['foo', 'bar']) - assert ws1.trigger.called and ws2.trigger.called and not ws3.trigger.called and not ws4.trigger.called - - def test_broadcast_error(self, ws4, monkeypatch): - monkeypatch.setattr(log, 'warning', Mock()) - WebSocketDispatcher.broadcast('foo') - assert not ws4.trigger.called and not log.warning.called - WebSocketDispatcher.broadcast('baf') - assert ws4.trigger.called and log.warning.called and not ws4.unsubscribe_all.called - - def test_broadcast_closed(self, ws1, ws2): - ws1.is_closed = True - WebSocketDispatcher.broadcast('foo') - assert ws2.trigger.called and not ws1.trigger.called - assert ws1.unsubscribe_all.called and not ws2.unsubscribe_all.called - - -def test_basic_send(wsd): - wsd.send(foo='bar', baz=None) - WebSocket.send.assert_called_with(ANY, '{"foo":"bar"}') - - -def test_send_client_caching(wsd): - wsd.send(client='xxx', data=123) - wsd.send(client='xxx', data=123) - wsd.send(client='yyy', data=321) - assert WebSocket.send.call_count == 2 - - -def test_no_send_caching_without_client(wsd): - wsd.send(data=123) - wsd.send(data=123) - wsd.send(data=321) - assert WebSocket.send.call_count == 3 - - -def test_callback_based_send_caching(wsd): - wsd.send(client='xxx', callback='yyy', data=123) - wsd.send(client='xxx', callback='yyy', data=123) - assert WebSocket.send.call_count == 1 - wsd.send(client='xxx', callback='zzz', data=123) - assert WebSocket.send.call_count == 2 - wsd.send(client='xxx', callback='yyy', data=123) - wsd.send(client='xxx', callback='zzz', data=123) - assert WebSocket.send.call_count == 2 - wsd.send(client='aaa', callback='yyy', data=123) - assert WebSocket.send.call_count == 3 - wsd.send(client='xxx', callback='yyy', data=321) - assert WebSocket.send.call_count == 4 - wsd.send(client='xxx', callback='zzz', data=123) - assert WebSocket.send.call_count == 4 - - -def test_get_method(wsd, service_patcher): - service_patcher('foo', { - 'bar': lambda: 'Hello World!', - 'baz': 'not a function', - '_private': lambda: 'private method' - }) - assert wsd.get_method('foo.bar')() == 'Hello World!' - pytest.raises(Exception, wsd.get_method, 'foo.baz') - pytest.raises(Exception, wsd.get_method, 'foo.baf') - pytest.raises(Exception, wsd.get_method, 'foo._private') - - -def test_unsubscribe_from_nonexistent(wsd): - wsd.unsubscribe('nonexistent') # does not error - - -def test_unsubscribe(wsd): - client = 'client-1' - wsd.client_locks[client] = RLock() - wsd.cached_queries[client] = {None: (Mock(), (), {}, {})} - wsd.cached_fingerprints[client][None] = 'fingerprint' - WebSocketDispatcher.subscriptions['foo'] = {wsd: {client: 'subscription'}} - wsd.handle_message({'action': 'unsubscribe', 'client': client}) - for d in [wsd.client_locks, wsd.cached_queries, wsd.cached_fingerprints, WebSocketDispatcher.subscriptions['foo']]: - assert client not in d - - -def test_multi_unsubscribe(wsd): - client = ['client-1', 'client-2'] - wsd.client_locks = {'client-1': RLock(), 'client-2': RLock()} - wsd.cached_fingerprints = {'client-1': 'fingerprint', 'client-2': 'fingerprint'} - wsd.cached_queries = {'client-1': {None: (Mock(), (), {}, {})}, 'client-2': {None: (Mock(), (), {}, {})}} - WebSocketDispatcher.subscriptions['foo'] = {wsd: {'client-1': 'subscription', 'client-2': 'subscription'}} - wsd.handle_message({'action': 'unsubscribe', 'client': client}) - for d in [wsd.client_locks, wsd.cached_queries, wsd.cached_fingerprints, WebSocketDispatcher.subscriptions['foo']]: - assert 'client-1' not in d - assert 'client-2' not in d - - -def test_unsubscribe_all(wsd, subscriptions): - assert wsd in WebSocketDispatcher.subscriptions['foo'] - assert wsd in WebSocketDispatcher.subscriptions['bar'] - sub1 = wsd.passthru_subscriptions['client-0'] = Mock() - sub2 = wsd.passthru_subscriptions['client-x'] = Mock() - - wsd.unsubscribe_all() - - assert wsd not in WebSocketDispatcher.subscriptions['foo'] - assert wsd not in WebSocketDispatcher.subscriptions['bar'] - assert 'client-0' not in wsd.passthru_subscriptions and 'client-x' not in wsd.passthru_subscriptions - assert sub1.unsubscribe.called and sub2.unsubscribe.called - - -def test_remote_unsubscribe(wsd, ws): - ws.unsubscribe = Mock() - ws._next_id = Mock(return_value='yyy') - threadlocal.reset(websocket=wsd, message={'client': 'xxx'}) - wsd.cached_queries['xxx'] = {None: (ws.make_caller('remote.foo'), (), {}, {})} - wsd.unsubscribe('xxx') - ws.unsubscribe.assert_called_with('yyy') - - -def test_update_subscriptions_with_new_callback(wsd): - wsd.update_subscriptions(client='client-0', callback='xxx', channels='foo') - assert WebSocketDispatcher.subscriptions['foo'][wsd]['client-0'] == {'callback-0', 'xxx'} - assert WebSocketDispatcher.subscriptions['bar'][wsd]['client-0'] == {None} - - -def test_update_subscriptions_with_existing_null_callback(wsd): - wsd.update_subscriptions(client='client-0', callback=None, channels='foo') - assert WebSocketDispatcher.subscriptions['foo'][wsd]['client-0'] == {'callback-0', None} - assert WebSocketDispatcher.subscriptions['bar'][wsd]['client-0'] == set() - - -def test_update_subscriptions_with_existing_callback(wsd): - wsd.update_subscriptions(client='client-0', callback='callback-0', channels='baz') - assert WebSocketDispatcher.subscriptions['foo'][wsd]['client-0'] == set() - assert WebSocketDispatcher.subscriptions['bar'][wsd]['client-0'] == {None} - assert WebSocketDispatcher.subscriptions['baz'][wsd]['client-0'] == {'callback-0'} - - -def test_update_subscriptions_with_multiple_channels(wsd): - wsd.update_subscriptions(client='client-0', callback='callback-0', channels=['foo', 'baz']) - assert WebSocketDispatcher.subscriptions['foo'][wsd]['client-0'] == {'callback-0'} - assert WebSocketDispatcher.subscriptions['bar'][wsd]['client-0'] == {None} - assert WebSocketDispatcher.subscriptions['baz'][wsd]['client-0'] == {'callback-0'} - - -@pytest.fixture -def trig(wsd): - wsd.cached_queries['xxx']['yyy'] = (lambda *args, **kwargs: [args, kwargs], ('a', 'b'), {'c': 'd'}, {}) - wsd.send = Mock() - return wsd - - -def increment(): - count = threadlocal.client_data.setdefault('count', 0) - count += 1 - threadlocal.client_data['count'] = count - return count - - -def test_trigger(trig): - trig.trigger(client='xxx', callback='yyy', trigger='zzz') - trig.send.assert_called_with(client='xxx', callback='yyy', trigger='zzz', data=[('a', 'b'), {'c': 'd'}]) - - -def test_trigger_without_id(trig): - trig.trigger(client='xxx', callback='yyy') - trig.send.assert_called_with(client='xxx', callback='yyy', trigger=None, data=[('a', 'b'), {'c': 'd'}]) - - -def test_trigger_without_known_client(trig): - trig.trigger(client='doesNotExist', callback='yyy') - assert not trig.send.called - - -def test_trigger_without_known_callback(trig): - trig.trigger(client='xxx', callback='doesNotExist') - assert not trig.send.called - - -def test_trigger_with_client_data(wsd, trig, monkeypatch): - client = 'client-1' - monkeypatch.setitem(wsd.subscriptions['foo'][wsd], client, [None]) - monkeypatch.setitem(wsd.cached_fingerprints, client, {None: 'fingerprint'}) - monkeypatch.setitem(wsd.cached_queries, client, {None: (increment, (), {}, {'count': 7})}) - - wsd.trigger(client=client, callback=None) - wsd.send.assert_called_with(client=client, callback=None, trigger=None, data=8) - - -@pytest.fixture -def up(wsd): - wsd.send = Mock() - wsd.update_subscriptions = Mock() - return wsd - - -@subscribes('foo') -def foosub(): - return 'e' - - -def test_update_triggers_client_and_callback(up): - up.update_triggers('xxx', 'yyy', foosub, ('a', 'b'), {'c': 'd'}, 'e', 123) - up.update_subscriptions.assert_called_with('xxx', 'yyy', ['foo']) - assert up.cached_queries['xxx']['yyy'] == (foosub, ('a', 'b'), {'c': 'd'}, {}) - assert not up.send.called - - -def test_update_triggers_client_no_callback(up): - up.update_triggers('xxx', None, foosub, ('a', 'b'), {'c': 'd'}, 'e', 123) - up.update_subscriptions.assert_called_with('xxx', None, ['foo']) - assert up.cached_queries['xxx'][None] == (foosub, ('a', 'b'), {'c': 'd'}, {}) - up.send.assert_called_with(trigger='subscribe', client='xxx', data='e', _time=123) - - -def test_update_triggers_no_client(up): - for callback in [None, 'yyy']: - up.update_triggers(None, 'yyy', foosub, ('a', 'b'), {'c': 'd'}, 'e', 123) - assert not up.update_subscriptions.called - assert 'yyy' not in up.cached_queries[None] - assert not up.send.called - - -def test_update_triggers_with_error(up): - up.update_triggers('xxx', None, foosub, ('a', 'b'), {'c': 'd'}, up.NO_RESPONSE, 123) - up.update_subscriptions.assert_called_with('xxx', None, ['foo']) - assert up.cached_queries['xxx'][None] == (foosub, ('a', 'b'), {'c': 'd'}, {}) - assert not up.send.called - - -@pytest.fixture -def act(wsd, monkeypatch): - wsd.unsubscribe = Mock() - monkeypatch.setattr(log, 'warning', Mock()) - return wsd - - -def test_unsubscribe_action(act): - act.unsubscribe = Mock() - act.internal_action('unsubscribe', 'xxx', 'yyy') - act.unsubscribe.assert_called_with('xxx') - assert not log.warning.called - - -def test_unknown_action(act): - act.internal_action('does_not_exist', 'xxx', 'yyy') - assert not act.unsubscribe.called - assert log.warning.called - - -def test_no_action(act): - act.internal_action(None, 'xxx', 'yyy') - assert not act.unsubscribe.called - assert not log.warning.called - - -@pytest.fixture -def receiver(wsd, monkeypatch): - monkeypatch.setattr(log, 'error', Mock()) - monkeypatch.setattr(responder, 'defer', Mock()) - wsd.send = Mock() - return wsd - -Message = namedtuple('Message', ['data']) - - -def test_received_message(receiver): - receiver.received_message(Message('{}')) - responder.defer.assert_called_with(ANY, {}) - assert not receiver.send.called - assert not log.error.called - - -def test_received_invalid_message(receiver): - receiver.received_message(Message('not valid json')) - assert not responder.defer.called - receiver.send.assert_called_with(error=ANY) - assert log.error.called - - -def test_received_non_dict(receiver): - receiver.received_message(Message('"valid json but not a dict"')) - assert not responder.defer.called - receiver.send.assert_called_with(error=ANY) - assert log.error.called - - -@pytest.fixture -def handler(ws, wsd, service_patcher, monkeypatch): - service_patcher('remote', ws) - service_patcher('foo', { - 'bar': Mock(return_value='baz'), - 'err': Mock(side_effect=Exception) - }) - ws.subscribe = Mock() - ws.call = Mock(return_value=12345) - monkeypatch.setattr(log, 'error', Mock()) - monkeypatch.setattr(threadlocal, 'reset', Mock(side_effect=threadlocal.reset)) - wsd.send = Mock() - wsd.internal_action = Mock() - wsd.update_triggers = Mock() - return wsd - - -def test_handle_message_with_callback(handler): - message = { - 'method': 'foo.bar', - 'params': 'baf', - 'callback': 'xxx' - } - handler.handle_message(message) - threadlocal.reset.assert_called_with(websocket=handler, message=message, headers=mock_header_data, - **mock_session_data) - handler.internal_action.assert_called_with(None, None, 'xxx') - handler.update_triggers.assert_called_with(None, 'xxx', services.foo.bar, ['baf'], {}, 'baz', ANY) - handler.send.assert_called_with(data='baz', callback='xxx', client=None, _time=ANY) - assert not log.error.called - - -def test_handle_method_with_client(handler): - message = { - 'method': 'foo.bar', - 'params': {'baf': 1}, - 'client': 'xxx' - } - handler.handle_message(message) - threadlocal.reset.assert_called_with(websocket=handler, message=message, headers=mock_header_data, - **mock_session_data) - handler.internal_action.assert_called_with(None, 'xxx', None) - handler.update_triggers.assert_called_with('xxx', None, services.foo.bar, [], {'baf': 1}, 'baz', ANY) - assert not handler.send.called - assert not log.error.called - - -def test_handle_message_client_error(handler): - message = {'method': 'foo.err', 'client': 'xxx'} - handler.handle_message(message) - threadlocal.reset.assert_called_with(websocket=handler, message=message, headers=mock_header_data, - **mock_session_data) - handler.internal_action.assert_called_with(None, 'xxx', None) - handler.update_triggers.assert_called_with('xxx', None, services.foo.err, [], {}, handler.NO_RESPONSE, ANY) - assert log.error.called - handler.send.assert_called_with(error=ANY, client='xxx', callback=None) - assert handler.send.call_count == 1 - - -def test_handle_message_callback_error(handler): - message = {'method': 'foo.err', 'callback': 'xxx'} - handler.handle_message(message) - threadlocal.reset.assert_called_with(websocket=handler, message=message, headers=mock_header_data, - **mock_session_data) - handler.internal_action.assert_called_with(None, None, 'xxx') - handler.update_triggers.assert_called_with(None, 'xxx', services.foo.err, [], {}, handler.NO_RESPONSE, ANY) - assert log.error.called - handler.send.assert_called_with(error=ANY, callback='xxx', client=None) - assert handler.send.call_count == 1 - - -def test_handle_message_remote_call(handler, ws): - message = {'method': 'remote.method', 'callback': 'xxx', 'params': [1, 2]} - handler.handle_message(message) - ws.call.assert_called_with('remote.method', 1, 2) - assert not ws.subscribe.called - handler.send.assert_called_with(callback='xxx', data=12345, client=None, _time=ANY) - - -def test_handle_message_remote_subscribe(handler, ws): - message = {'method': 'remote.method', 'client': 'xxx', 'params': [1, 2]} - handler.handle_message(message) - ws.subscribe.assert_called_with(ANY, 'remote.method', 1, 2) - assert not ws.call.called - assert not handler.send.called - - -def test_skip_send_if_closed(monkeypatch, wsd): - wsd.send() - monkeypatch.setattr(WebSocketDispatcher, 'is_closed', True) - wsd.send() - assert WebSocket.send.call_count == 1 - - -def test_explicit_call_resets_cache(service_patcher, wsd): - service_patcher('foo', { - 'bar': lambda: 'Hello World' - }) - message = {'method': 'foo.bar', 'client': 'client-1', 'callback': 'callback-2'} - wsd.handle_message(message) - assert 'callback-2' in wsd.cached_fingerprints['client-1'] - assert WebSocket.send.call_count == 1 - wsd.handle_message(message) - assert WebSocket.send.call_count == 2 diff --git a/sideboard/websockets.py b/sideboard/websockets.py deleted file mode 100755 index ac6c4c6..0000000 --- a/sideboard/websockets.py +++ /dev/null @@ -1,798 +0,0 @@ -from __future__ import unicode_literals -import sys -import json -import time -import hashlib -import logging -import traceback -from copy import deepcopy -from functools import wraps -from threading import local, RLock -from collections import defaultdict - -import six -import cherrypy - -from ws4py.websocket import WebSocket -from ws4py.server.cherrypyserver import WebSocketPlugin, WebSocketTool - -import sideboard.lib -from sideboard.lib import log, class_property, Caller -from sideboard.config import config - -local_subscriptions = defaultdict(list) -DELAYED_NOTIFICATIONS_KEY = 'sideboard.delayed_notifications' - - -class threadlocal(object): - """ - This class exposes a dict-like interface on top of the threading.local - utility class; the "get", "set", "setdefault", and "clear" methods work the - same as for a dict except that each thread gets its own keys and values. - - Sideboard clears out all existing values and then initializes some specific - values in the following situations: - - 1) CherryPy page handlers have the 'username' key set to whatever value is - returned by cherrypy.session['username']. - - 2) Service methods called via JSON-RPC have the following two fields set: - -> username: as above - -> websocket_client: if the JSON-RPC request has a "websocket_client" - field, it's value is set here; this is used internally as the - "originating_client" value in notify() and plugins can ignore this - - 3) Service methods called via websocket have the following three fields set: - -> username: as above - -> websocket: the WebSocketDispatcher instance receiving the RPC call - -> client_data: see the client_data property below for an explanation - -> message: the RPC request body; this is present on the initial call - but not on subscription triggers in the broadcast thread - """ - _threadlocal = local() - - @classmethod - def get(cls, key, default=None): - return getattr(cls._threadlocal, key, default) - - @classmethod - def set(cls, key, val): - return setattr(cls._threadlocal, key, val) - - @classmethod - def setdefault(cls, key, val): - val = cls.get(key, val) - cls.set(key, val) - return val - - @classmethod - def clear(cls): - cls._threadlocal.__dict__.clear() - - @classmethod - def get_client(cls): - """ - If called as part of an initial websocket RPC request, this returns the - client id if one exists, and otherwise returns None. Plugins probably - shouldn't need to call this method themselves. - """ - return cls.get('client') or cls.get('message', {}).get('client') - - @classmethod - def reset(cls, **kwargs): - """ - Plugins should never call this method directly without a good reason; it - clears out all existing values and replaces them with the key-value - pairs passed as keyword arguments to this function. - """ - cls.clear() - for key, val in kwargs.items(): - cls.set(key, val) - - @class_property - def client_data(cls): - """ - This propery is basically the websocket equivalent of cherrypy.session; - it's a dictionary where your service methods can place data which you'd - like to use in subsequent method calls. - """ - return cls.setdefault('client_data', {}) - - -def _normalize_channels(*channels): - """ - Converts a list of types, strings, or whatever else into a list of strings. - - >>> _normalize_channels() - [] - - >>> _normalize_channels('') - [] - - >>> _normalize_channels(' ') - [] - - >>> _normalize_channels(None) - [] - - >>> _normalize_channels('topic-one', 'topic-two') - ['topic-one', 'topic-two'] - - >>> _normalize_channels('repeated-topic', 'repeated-topic') - ['repeated-topic'] - - >>> _normalize_channels('topic-left', None, 'topic-right', None) - ['topic-left', 'topic-right'] - - >>> _normalize_channels('', 'topic-left', '', 'topic-right') - ['topic-left', 'topic-right'] - - >>> _normalize_channels(' ', ' topic-padded-left', ' ', 'topic-padded-right ', ' ') - ['topic-padded-left', 'topic-padded-right'] - - >>> _normalize_channels(type) - ['type'] - - >>> _normalize_channels(dict) - ['dict'] - - >>> _normalize_channels(dict(foo="bar")) - ["{'foo': 'bar'}"] - """ - normalized_channels = [] - for topic in channels: - if topic is not None: - if isinstance(topic, type): - normalized_channels.append(topic.__name__) - elif isinstance(topic, six.string_types): - topic = topic.strip() - if topic != '': - normalized_channels.append(topic) - else: - normalized_channels.append(str(topic)) - return list(set(normalized_channels)) - - -def notify(channels, trigger="manual", delay=False, originating_client=None): - """ - Manually trigger all subscriptions on the given channels. The following - optional parameters may be specified: - - trigger: Used in log messages if you want to distinguish between triggers. - delay: Boolean indicating whether the notification should happen immediately - or after the current WebSocket RPC method has completed. Note that - if this parameter is set when notify is called outside of a WebSocket - RPC request, no notification will ever happen. - originating_client: Websocket subscriptions will NOT fire if they have the - same client as the trigger. - """ - channels = _normalize_channels(*sideboard.lib.listify(channels)) - context = { - 'trigger': trigger, - 'originating_client': originating_client or threadlocal.get_client() - } - if delay: - threadlocal.setdefault(DELAYED_NOTIFICATIONS_KEY, []).append([channels, context]) - else: - broadcaster.defer(channels, **context) - local_broadcaster.defer(channels, **context) - - -def trigger_delayed_notifications(): - """ - Sometimes plugins might want to call notify() and have it trigger after - their RPC method has completed its call. For example, a plugin might call - notify() in the middle of a database transaction and want the notification - to happen after a commit has occurred. When notify() is called with - delay=True then it appends to a list, and this method goes through that list - and triggers broadcasts for those notifications. - """ - if threadlocal.get(DELAYED_NOTIFICATIONS_KEY): - for channels, context in threadlocal.get(DELAYED_NOTIFICATIONS_KEY): - broadcaster.defer(channels, **context) - local_broadcaster.defer(channels, **context) - threadlocal.set(DELAYED_NOTIFICATIONS_KEY, []) - - -def notifies(*args, **kwargs): - """ - Adds a notifies attribute to the decorated function. The notifies - attribute specifies a list of the channels which the function notifies. - - >>> @notifies('topic-one', 'topic-two') - ... def fn(): - ... pass - >>> getattr(fn, 'notifies') - ['topic-one', 'topic-two'] - - >>> @notifies(dict) - ... def fn_dict(): - ... pass - >>> getattr(fn_dict, 'notifies') - ['dict'] - """ - channels = _normalize_channels(*args) - - def decorated_func(func): - @wraps(func) - def notifier_func(*args, **kwargs): - try: - return func(*args, **kwargs) - finally: - notify(channels, trigger=func.__name__) - - notifier_func.notifies = channels - return notifier_func - - return decorated_func - - -def subscribes(*args): - """ - Adds a subscribes attribute to the decorated function. The subscribes - attribute specifies a list of the channels to which the function subscribes. - - >>> @subscribes('topic-one', 'topic-two') - ... def fn(): - ... pass - >>> getattr(fn, 'subscribes') - ['topic-one', 'topic-two'] - - >>> @subscribes(dict) - ... def fn_dict(): - ... pass - >>> getattr(fn_dict, 'subscribes') - ['dict'] - """ - channels = _normalize_channels(*args) - - def decorated_func(func): - func.subscribes = channels - return func - - return decorated_func - - -def locally_subscribes(*args): - """ - The @subscribes decorator registers a function as being one which clients - may subscribe to via websocket. This decorator may be used to register a - function which shall be called locally anytime a notify occurs, e.g. - - @locally_subscribes('example.channel') - def f(): - print('f was called') - - notify('example.channel') # causes f() to be called in a separate thread - """ - def decorated_func(func): - for channel in _normalize_channels(*args): - local_subscriptions[channel].append(func) - return func - - return decorated_func - - -def local_broadcast(channels, trigger=None, originating_client=None): - """Triggers callbacks registered via @locally_subscribes""" - triggered = set() - for channel in sideboard.lib.listify(channels): - for callback in local_subscriptions[channel]: - triggered.add(callback) - - for callback in triggered: - threadlocal.reset(trigger=trigger, originating_client=originating_client) - try: - callback() - except: - log.error('unexpected error on local broadcast callback', exc_info=True) - - -def _fingerprint(x): - """ - Calculates the md5 sum of the given argument. - - If _fingerprint is passed a string, it calculates the md5 sum of the - string. If _fingerprint is passed anything else, then the json encoding - of the argument is used to calculate the md5 sum. - - >>> _fingerprint(None) - '37a6259cc0c1dae299a7866489dff0bd' - - >>> _fingerprint('test') - '098f6bcd4621d373cade4e832627b4f6' - - >>> _fingerprint({'key':'value'}) - 'a7353f7cddce808de0032747a0b7be50' - - >>> _fingerprint(dict(key='value')) - 'a7353f7cddce808de0032747a0b7be50' - - >>> _fingerprint({'a':1, 'b':2}) - '608de49a4600dbb5b173492759792e4a' - - >>> _fingerprint({'b':2, 'a':1}) - '608de49a4600dbb5b173492759792e4a' - - >>> _fingerprint({'a':{'x':3, 'y':4}, 'b':2}) - '2c22e445e9278c66dd7ea78b757defe6' - - >>> _fingerprint({'b':2, 'a':{'y':4, 'x':3}}) - '2c22e445e9278c66dd7ea78b757defe6' - """ - md5 = hashlib.md5() - if not isinstance(x, six.string_types): - x = json.dumps(x, cls=sideboard.lib.serializer, sort_keys=True, separators=(',', ':')) - md5.update(x.encode('utf-8') if six.PY3 else x) - return md5.hexdigest() - - -def get_params(params): - if params is None: - return [], {} - elif isinstance(params, dict): - return [], params - elif isinstance(params, list): - return params, {} - else: - return [params], {} - - -class WebSocketDispatcher(WebSocket): - """ - This class is instantiated for each incoming websocket connection. Each - instance of this class has its own socket object and its own thread. This - class is where we respond to RPC requests. - """ - - NO_RESPONSE = object() - """ - This object is used as a sentinel value for situations where we want to - avoid double-sending a response. For example, when an RPC request for a - subscription arrives, we "trigger" a subscription response immediately, so - there's no need to actually call "send" on the return value. - - This is an internal implementation detail and plugins shouldn't need to know - or care that this field exists. - """ - - subscriptions = defaultdict(lambda: defaultdict(lambda: defaultdict(set))) - """ - This tracks all subscriptions for all incoming websocket connections. The - structure looks like this: - - { - 'channel_id': { - : { - 'client_id': {'callback_id_one', 'callback_id_two', ...}, - }, - ... - }, - ... - } - - This allows us to do things like trigger a broadcast to all websockets - subscribed on a channel. Instances of this class are responsible for - adding and removing their subscriptions from this data structure. - """ - - instances = set() - """ - When debugging Sideboard, it can be useful to introspect a list of all - open websocket connections which have been made to this server. Instances - of this class add themselves to this set when instantiated and remove - themselves when closed. - """ - - def __init__(self, *args, **kwargs): - """ - This passes all arguments to the parent constructor. In addition, it - defines the following instance variables: - - send_lock: Used to guarantee thread-safety when sending RPC responses. - - client_locks: A dict mapping client ids to locks used by those clients. - - passthru_subscriptions: When we recieve a subscription request for a - service method registered on a remote service, we pass that request - along to the remote service and send back the responses. This - dictionary maps client ids to those subscription objects. - - session_fields: We copy session data for the currently-authenticated - user who made the incoming websocket connection; by default we only - copy the username, but this can be overridden in configuration. - - header_fields: We copy header fields from the request that initiated the - websocket connection. - - cached_queries and cached_fingerprints: When we receive a subscription - update, Sideboard re-runs all of the subscription methods to see if - new data needs to be pushed out. We do this by storing all of the - rpc methods and an MD5 hash of their return values. We store a hash - rather than the return values themselves to save on memory, since - return values may be very large. - - The cached_queries dict has this structure: - { - 'client_id': { - 'callback_id': (func, args, kwargs, client_data), - ... - }, - ... - } - - The cached_fingerprints dict has this structure: - { - 'client_id': { - 'callback_id': 'md5_hash_of_return_value', - ... - }, - ... - } - """ - WebSocket.__init__(self, *args, **kwargs) - self.instances.add(self) - self.send_lock = RLock() - self.passthru_subscriptions = {} - self.client_locks = defaultdict(RLock) - self.cached_queries, self.cached_fingerprints = defaultdict(dict), defaultdict(dict) - self.session_fields = self.check_authentication() - self.header_fields = self.fetch_headers() - - @classmethod - def fetch_headers(cls): - """ - This method returns a dict with all of the header fields we want to - store for this websocket so that we can set them as threadlocal global - variables for all subsequent websocket RPC requests. - """ - return {field: cherrypy.request.headers.get(field) for field in config['ws.header_fields']} - - @classmethod - def check_authentication(cls): - """ - This method raises an exception if the user is not currently logged in, - and otherwise returns a dict with all of the session fields we want to - store for this websocket so that we can set them as threadlocal global - variables for all subsequent websocket RPC requests. By default we only - return the username of the currently-logged-in user in this manner, but - this can be changed via the ws.session_fields config option. Subclasses - can also override this method to change how we handle authentication. - """ - return {field: cherrypy.session.get(field) for field in config['ws.session_fields']} - - @classmethod - def get_all_subscribed(cls): - """Returns a set of all instances of this class with active subscriptions.""" - websockets = set() - for channel, subscriptions in cls.subscriptions.items(): - for websocket, clients in subscriptions.items(): - websockets.add(websocket) - return websockets - - @classmethod - def broadcast(cls, channels, trigger=None, originating_client=None): - """ - Trigger all subscriptions on the given channel(s). This method is - called in the "broadcaster" thread, which means that all subscription - updates happen in the same thread. - - Callers can pass an "originating_client" id, which will prevent data - from being pushed to those clients. This is useful in cases like this: - -> a Javascipt application makes a call like "ecard.delete" - -> not wanting to wait for a subscription update, the Javascript app - preemptively updates its local data store to remove the item - -> the response to the delete call comes back as a success - -> because the local data store was already updated, there's no need - for this client to get a subscription update - - Callers can pass a "trigger" field, which will be included in the - subscription update message as the reason for the update. This doesn't - affect anything, but might be useful for logging. - """ - triggered = set() - for channel in sideboard.lib.listify(channels): - for websocket, clients in list(cls.subscriptions[channel].items()): - if websocket.is_closed: - websocket.unsubscribe_all() - else: - for client, callbacks in clients.copy().items(): - if client != originating_client: - for callback in callbacks: - triggered.add((websocket, client, callback)) - - for websocket, client, callback in triggered: - try: - websocket.trigger(client=client, callback=callback, trigger=trigger) - except: - log.warning('ignoring unexpected trigger error', exc_info=True) - - @property - def is_closed(self): - """ - The "terminated" attribute tells us whether the socket was explictly - closed, this property performs a more rigorous check to let us know - if any of the fields which indicate the socket has been closed have been - set; this allows us to avoid spurious error messages by not attempting - to send messages on a socket which is in the process of closing. - """ - return not self.stream or self.client_terminated or self.server_terminated or not self.sock - - def client_lock(self, client): - """ - Sideboard has a pool of background threads which simultaneously executes - method calls, but it performs per-subscription locking to ensure thread - safety for our subscription-related data structures. Thus, if the same - connected websocket sends two method calls with the same client id, - those calls will be handled sequentially rather than concurrently. - - This utility method supports this by returning a context manager which - acquires the necessary locks on entrance and releases them on exit. It - takes either a client id or list of client ids. - """ - ordered_clients = sorted(sideboard.lib.listify(client or [])) - ordered_locks = [self.client_locks[oc] for oc in ordered_clients] - - class MultiLock(object): - def __enter__(inner_self): - for lock in ordered_locks: - lock.acquire() - - def __exit__(inner_self, *args, **kwargs): - for lock in reversed(ordered_locks): - lock.release() - - return MultiLock() - - def send(self, **message): - """ - This overrides the ws4py-provided send to implement three new features: - - 1) Instead of taking a string, this method treats its keyword arguments - as the message, serializes them to JSON, and sends that. - - 2) For subscription responses, we keep track of the most recent response - we sent for the given subscription. If neither the request or - response have changed since the last time we pushed data back to the - client for this subscription, we don't send anything. - - 3) We lock when sending to ensure that our sends are thread-safe. - Surprisingly, the "ws4py.threadedclient" class isn't thread-safe! - - 4) Subscriptions firing will sometimes trigger a send on a websocket - which has already been marked as closed. When this happens we log a - debug message and then exit without error. - """ - if self.is_closed: - log.debug('ignoring send on an already closed websocket: %s', message) - self.unsubscribe_all() - return - - message = {k: v for k, v in message.items() if v is not None} - if 'data' in message and 'client' in message: - fingerprint = _fingerprint(message['data']) - client, callback = message['client'], message.get('callback') - repeat_send = callback in self.cached_fingerprints[client] - cached_fingerprint = self.cached_fingerprints[client].get(callback) - self.cached_fingerprints[client][callback] = fingerprint - if cached_fingerprint == fingerprint and repeat_send: - return - - log.debug('sending %s', message) - message = json.dumps(message, cls=sideboard.lib.serializer, - separators=(',', ':'), sort_keys=True) - with self.send_lock: - if not self.is_closed: - WebSocket.send(self, message) - - def closed(self, code, reason=''): - """ - This overrides the default closed handler to first clean up all of our - subscriptions, remove this websocket from the registry of instances, - and log a message before closing. - """ - log.info('closing: code=%s reason=%s', code, reason) - self.instances.discard(self) - self.unsubscribe_all() - WebSocket.closed(self, code, reason) - - def teardown_passthru(self, client): - """ - Given a client id, check whether there's a "passthrough subscription" - for that client and clean it up if one exists. - """ - subscription = self.passthru_subscriptions.pop(client, None) - if subscription: - subscription.unsubscribe() - - def get_method(self, action): - """ - Given a method string in the format "module_name.function_name", - return a callable object representing that function, raising an - exception if the format is invalid or no such method exists. - """ - service_name, method_name = action.split('.') - service = getattr(sideboard.lib.services, service_name) - method = getattr(service, method_name) - return method - - def unsubscribe(self, clients): - """ - Given a client id or list of client ids, clean up those subscriptions - from the internal data structures of this class. - """ - for client in sideboard.lib.listify(clients or []): - self.teardown_passthru(client) - self.client_locks.pop(client, None) - self.cached_queries.pop(client, None) - self.cached_fingerprints.pop(client, None) - for clients in self.subscriptions.values(): - clients[self].pop(client, None) - - def unsubscribe_all(self): - """Called on close to tear down all of this websocket's subscriptions.""" - for clients in self.subscriptions.values(): - clients.pop(self, {}) - - for passthru_client in list(self.passthru_subscriptions.keys()): - self.teardown_passthru(passthru_client) - - def update_subscriptions(self, client, callback, channels): - """Updates WebSocketDispatcher.subscriptions for the given client/channels.""" - for clients in self.subscriptions.values(): - clients[self][client].discard(callback) - - for channel in sideboard.lib.listify(channels): - self.subscriptions[channel][self][client].add(callback) - - def trigger(self, client, callback, trigger=None): - """ - This is the method called by the global broadcaster thread when a - notification is posted to a channel this client is subscribed to. It - re-calls the function and sends the result back to the client. - """ - if callback in self.cached_queries[client]: - function, args, kwargs, client_data = self.cached_queries[client][callback] - threadlocal.reset(websocket=self, client_data=client_data, headers=self.header_fields, **self.session_fields) - result = function(*args, **kwargs) - self.send(trigger=trigger, client=client, callback=callback, data=result) - - def update_triggers(self, client, callback, function, args, kwargs, result, duration=None): - """ - This is called after an RPC function is invoked; it takes the function - and its return value and updates our internal data structures then sends - the response back to the client. - """ - if hasattr(function, 'subscribes') and client is not None: - self.cached_queries[client][callback] = (function, args, kwargs, threadlocal.client_data) - self.update_subscriptions(client, callback, function.subscribes) - if client is not None and callback is None and result is not self.NO_RESPONSE: - self.send(trigger='subscribe', client=client, data=result, _time=duration) - - def internal_action(self, action, client, callback): - """ - Sideboard currently supports both method calls and "internal actions" - which affect the state of the websocket connection itself. This - implements the command-dispatch pattern to perform the given action and - raises an exception if that action doesn't exist. - - The only action currently implemented is "unsubscribe". - """ - if action == 'unsubscribe': - self.unsubscribe(client) - elif action is not None: - log.warning('unknown action %s', action) - - def clear_cached_response(self, client, callback): - """ - As explained above, Sideboard caches the most recent response to a - subscription so that when we check the subscription we can see if new - data needs to be sent. However, if the user makes a series of requests - with the same client/callback ids which return the same response, they - probably still expect to get data back. This method is therefore called - every time we receive an explicit RPC call for a subscription to discard - the cached value, ensuring that an explicit RPC call to a service - exposed via websocket always receives a response. - """ - self.cached_fingerprints[client].pop(callback, None) - - def received_message(self, message): - """ - This overrides the default ws4py event handler to parse the incoming - message and pass it off to our pool of background threads, which call - this class' handle_message function to perform the relevant RPC actions. - """ - try: - data = message.data if isinstance(message.data, six.text_type) else message.data.decode('utf-8') - fields = json.loads(data) - assert isinstance(fields, dict) - except: - message = 'incoming websocket message was not a json object: {}'.format(message.data) - log.error(message) - self.send(error=message) - else: - log.debug('received %s', fields) - responder.defer(self, fields) - - def handle_message(self, message): - """ - Given a message dictionary, perform the relevant RPC actions and send - out the response. This function is called from a pool of background - threads - """ - before = time.time() - duration, result = None, None - threadlocal.reset(websocket=self, message=message, headers=self.header_fields, **self.session_fields) - action, callback, client, method = message.get('action'), message.get('callback'), message.get('client'), message.get('method') - try: - with self.client_lock(client): - self.internal_action(action, client, callback) - if method: - self.clear_cached_response(client, callback) - func = self.get_method(method) - args, kwargs = get_params(message.get('params')) - result = self.NO_RESPONSE - try: - result = func(*args, **kwargs) - duration = (time.time() - before) if config['debug'] else None - finally: - trigger_delayed_notifications() - self.update_triggers(client, callback, func, args, kwargs, result, duration) - except: - log.error('unexpected websocket dispatch error', exc_info=True) - exc_class, exc, tb = sys.exc_info() - str_content = str(exc) or 'Unexpected Error.' - message = (str_content + '\n' + traceback.format_exc()) if config['debug'] else str_content - self.send(error=message, callback=callback, client=client) - else: - if callback is not None and result is not self.NO_RESPONSE: - self.send(data=result, callback=callback, client=client, _time=duration) - - def __repr__(self): - return '<{} {}>'.format( - self.__class__.__name__, - ' '.join('{}={}'.format(k, v) for k, v in self.session_fields.items()) - ) - - -class WebSocketAuthError(Exception): - """ - Exception raised by WebSocketDispatcher subclasses to indicate that there is - not a currently-logged-in user able to make a websocket connection. - """ - - -class WebSocketRoot(object): - @cherrypy.expose - def default(self): - pass - - -class WebSocketChecker(WebSocketTool): - def __init__(self): - cherrypy.Tool.__init__(self, 'before_handler', self.upgrade) - self._priority = cherrypy.tools.sessions._priority + 1 # must be initialized after the sessions tool - - def upgrade(self, **kwargs): - try: - kwargs['handler_cls'].check_authentication() - except WebSocketAuthError: - raise cherrypy.HTTPError(401, 'You must be logged in to establish a websocket connection.') - except: - log.error('unexpected websocket authentication error', exc_info=True) - raise cherrypy.HTTPError(401, 'unexpected authentication error') - else: - return WebSocketTool.upgrade(self, **kwargs) - -cherrypy.tools.websockets = WebSocketChecker() - -websocket_plugin = WebSocketPlugin(cherrypy.engine) -if hasattr(WebSocketPlugin.start, '__func__'): - WebSocketPlugin.start.__func__.priority = 66 -else: - WebSocketPlugin.start.priority = 66 -websocket_plugin.subscribe() - -local_broadcaster = Caller(local_broadcast) -broadcaster = Caller(WebSocketDispatcher.broadcast) -responder = Caller(WebSocketDispatcher.handle_message, threads=config['ws.thread_pool']) diff --git a/test-defaults.ini b/test-defaults.ini deleted file mode 100644 index 970fdb0..0000000 --- a/test-defaults.ini +++ /dev/null @@ -1,30 +0,0 @@ - -# The settings in this file (test-defaults.ini) can be overridden in test.ini. - -debug = True -ws.auth_required = False - -is_test_running = True - -[cherrypy] -engine.autoreload.on = False -profiling.on = False -server.socket_host = "127.0.0.1" - -# By default the test server runs on port 8282. If you are already using -# port 8282, you'll receive errors like: -# OSError: Port 8282 not free on '127.0.0.1' -# -# You can change this setting in test.ini to either another free port, or -# to port 0 (meaning a free port will be chosen by the OS automatically). -# Using port 0 is mostly safe, but on heavily used systems there is a -# potential race condition if another process uses the same port in the time -# between requesting an available port and actually using it. -# -# See https://eklitzke.org/binding-on-port-zero -# -server.socket_port = 8282 - - -[loggers] -root = "DEBUG" diff --git a/tests/karma/deps/angular-1.2.16.js b/tests/karma/deps/angular-1.2.16.js deleted file mode 100644 index 2f26bee..0000000 --- a/tests/karma/deps/angular-1.2.16.js +++ /dev/null @@ -1,21464 +0,0 @@ -/** - * @license AngularJS v1.2.16 - * (c) 2010-2014 Google, Inc. http://angularjs.org - * License: MIT - */ -(function(window, document, undefined) {'use strict'; - -/** - * @description - * - * This object provides a utility for producing rich Error messages within - * Angular. It can be called as follows: - * - * var exampleMinErr = minErr('example'); - * throw exampleMinErr('one', 'This {0} is {1}', foo, bar); - * - * The above creates an instance of minErr in the example namespace. The - * resulting error will have a namespaced error code of example.one. The - * resulting error will replace {0} with the value of foo, and {1} with the - * value of bar. The object is not restricted in the number of arguments it can - * take. - * - * If fewer arguments are specified than necessary for interpolation, the extra - * interpolation markers will be preserved in the final string. - * - * Since data will be parsed statically during a build step, some restrictions - * are applied with respect to how minErr instances are created and called. - * Instances should have names of the form namespaceMinErr for a minErr created - * using minErr('namespace') . Error codes, namespaces and template strings - * should all be static strings, not variables or general expressions. - * - * @param {string} module The namespace to use for the new minErr instance. - * @returns {function(code:string, template:string, ...templateArgs): Error} minErr instance - */ - -function minErr(module) { - return function () { - var code = arguments[0], - prefix = '[' + (module ? module + ':' : '') + code + '] ', - template = arguments[1], - templateArgs = arguments, - stringify = function (obj) { - if (typeof obj === 'function') { - return obj.toString().replace(/ \{[\s\S]*$/, ''); - } else if (typeof obj === 'undefined') { - return 'undefined'; - } else if (typeof obj !== 'string') { - return JSON.stringify(obj); - } - return obj; - }, - message, i; - - message = prefix + template.replace(/\{\d+\}/g, function (match) { - var index = +match.slice(1, -1), arg; - - if (index + 2 < templateArgs.length) { - arg = templateArgs[index + 2]; - if (typeof arg === 'function') { - return arg.toString().replace(/ ?\{[\s\S]*$/, ''); - } else if (typeof arg === 'undefined') { - return 'undefined'; - } else if (typeof arg !== 'string') { - return toJson(arg); - } - return arg; - } - return match; - }); - - message = message + '\nhttp://errors.angularjs.org/1.2.16/' + - (module ? module + '/' : '') + code; - for (i = 2; i < arguments.length; i++) { - message = message + (i == 2 ? '?' : '&') + 'p' + (i-2) + '=' + - encodeURIComponent(stringify(arguments[i])); - } - - return new Error(message); - }; -} - -/* We need to tell jshint what variables are being exported */ -/* global - -angular, - -msie, - -jqLite, - -jQuery, - -slice, - -push, - -toString, - -ngMinErr, - -_angular, - -angularModule, - -nodeName_, - -uid, - - -lowercase, - -uppercase, - -manualLowercase, - -manualUppercase, - -nodeName_, - -isArrayLike, - -forEach, - -sortedKeys, - -forEachSorted, - -reverseParams, - -nextUid, - -setHashKey, - -extend, - -int, - -inherit, - -noop, - -identity, - -valueFn, - -isUndefined, - -isDefined, - -isObject, - -isString, - -isNumber, - -isDate, - -isArray, - -isFunction, - -isRegExp, - -isWindow, - -isScope, - -isFile, - -isBlob, - -isBoolean, - -trim, - -isElement, - -makeMap, - -map, - -size, - -includes, - -indexOf, - -arrayRemove, - -isLeafNode, - -copy, - -shallowCopy, - -equals, - -csp, - -concat, - -sliceArgs, - -bind, - -toJsonReplacer, - -toJson, - -fromJson, - -toBoolean, - -startingTag, - -tryDecodeURIComponent, - -parseKeyValue, - -toKeyValue, - -encodeUriSegment, - -encodeUriQuery, - -angularInit, - -bootstrap, - -snake_case, - -bindJQuery, - -assertArg, - -assertArgFn, - -assertNotHasOwnProperty, - -getter, - -getBlockElements, - -hasOwnProperty, - -*/ - -//////////////////////////////////// - -/** - * @ngdoc module - * @name ng - * @module ng - * @description - * - * # ng (core module) - * The ng module is loaded by default when an AngularJS application is started. The module itself - * contains the essential components for an AngularJS application to function. The table below - * lists a high level breakdown of each of the services/factories, filters, directives and testing - * components available within this core module. - * - *
- */ - -/** - * @ngdoc function - * @name angular.lowercase - * @module ng - * @function - * - * @description Converts the specified string to lowercase. - * @param {string} string String to be converted to lowercase. - * @returns {string} Lowercased string. - */ -var lowercase = function(string){return isString(string) ? string.toLowerCase() : string;}; -var hasOwnProperty = Object.prototype.hasOwnProperty; - -/** - * @ngdoc function - * @name angular.uppercase - * @module ng - * @function - * - * @description Converts the specified string to uppercase. - * @param {string} string String to be converted to uppercase. - * @returns {string} Uppercased string. - */ -var uppercase = function(string){return isString(string) ? string.toUpperCase() : string;}; - - -var manualLowercase = function(s) { - /* jshint bitwise: false */ - return isString(s) - ? s.replace(/[A-Z]/g, function(ch) {return String.fromCharCode(ch.charCodeAt(0) | 32);}) - : s; -}; -var manualUppercase = function(s) { - /* jshint bitwise: false */ - return isString(s) - ? s.replace(/[a-z]/g, function(ch) {return String.fromCharCode(ch.charCodeAt(0) & ~32);}) - : s; -}; - - -// String#toLowerCase and String#toUpperCase don't produce correct results in browsers with Turkish -// locale, for this reason we need to detect this case and redefine lowercase/uppercase methods -// with correct but slower alternatives. -if ('i' !== 'I'.toLowerCase()) { - lowercase = manualLowercase; - uppercase = manualUppercase; -} - - -var /** holds major version number for IE or NaN for real browsers */ - msie, - jqLite, // delay binding since jQuery could be loaded after us. - jQuery, // delay binding - slice = [].slice, - push = [].push, - toString = Object.prototype.toString, - ngMinErr = minErr('ng'), - - - _angular = window.angular, - /** @name angular */ - angular = window.angular || (window.angular = {}), - angularModule, - nodeName_, - uid = ['0', '0', '0']; - -/** - * IE 11 changed the format of the UserAgent string. - * See http://msdn.microsoft.com/en-us/library/ms537503.aspx - */ -msie = int((/msie (\d+)/.exec(lowercase(navigator.userAgent)) || [])[1]); -if (isNaN(msie)) { - msie = int((/trident\/.*; rv:(\d+)/.exec(lowercase(navigator.userAgent)) || [])[1]); -} - - -/** - * @private - * @param {*} obj - * @return {boolean} Returns true if `obj` is an array or array-like object (NodeList, Arguments, - * String ...) - */ -function isArrayLike(obj) { - if (obj == null || isWindow(obj)) { - return false; - } - - var length = obj.length; - - if (obj.nodeType === 1 && length) { - return true; - } - - return isString(obj) || isArray(obj) || length === 0 || - typeof length === 'number' && length > 0 && (length - 1) in obj; -} - -/** - * @ngdoc function - * @name angular.forEach - * @module ng - * @function - * - * @description - * Invokes the `iterator` function once for each item in `obj` collection, which can be either an - * object or an array. The `iterator` function is invoked with `iterator(value, key)`, where `value` - * is the value of an object property or an array element and `key` is the object property key or - * array element index. Specifying a `context` for the function is optional. - * - * It is worth noting that `.forEach` does not iterate over inherited properties because it filters - * using the `hasOwnProperty` method. - * - ```js - var values = {name: 'misko', gender: 'male'}; - var log = []; - angular.forEach(values, function(value, key){ - this.push(key + ': ' + value); - }, log); - expect(log).toEqual(['name: misko', 'gender: male']); - ``` - * - * @param {Object|Array} obj Object to iterate over. - * @param {Function} iterator Iterator function. - * @param {Object=} context Object to become context (`this`) for the iterator function. - * @returns {Object|Array} Reference to `obj`. - */ -function forEach(obj, iterator, context) { - var key; - if (obj) { - if (isFunction(obj)){ - for (key in obj) { - // Need to check if hasOwnProperty exists, - // as on IE8 the result of querySelectorAll is an object without a hasOwnProperty function - if (key != 'prototype' && key != 'length' && key != 'name' && (!obj.hasOwnProperty || obj.hasOwnProperty(key))) { - iterator.call(context, obj[key], key); - } - } - } else if (obj.forEach && obj.forEach !== forEach) { - obj.forEach(iterator, context); - } else if (isArrayLike(obj)) { - for (key = 0; key < obj.length; key++) - iterator.call(context, obj[key], key); - } else { - for (key in obj) { - if (obj.hasOwnProperty(key)) { - iterator.call(context, obj[key], key); - } - } - } - } - return obj; -} - -function sortedKeys(obj) { - var keys = []; - for (var key in obj) { - if (obj.hasOwnProperty(key)) { - keys.push(key); - } - } - return keys.sort(); -} - -function forEachSorted(obj, iterator, context) { - var keys = sortedKeys(obj); - for ( var i = 0; i < keys.length; i++) { - iterator.call(context, obj[keys[i]], keys[i]); - } - return keys; -} - - -/** - * when using forEach the params are value, key, but it is often useful to have key, value. - * @param {function(string, *)} iteratorFn - * @returns {function(*, string)} - */ -function reverseParams(iteratorFn) { - return function(value, key) { iteratorFn(key, value); }; -} - -/** - * A consistent way of creating unique IDs in angular. The ID is a sequence of alpha numeric - * characters such as '012ABC'. The reason why we are not using simply a number counter is that - * the number string gets longer over time, and it can also overflow, where as the nextId - * will grow much slower, it is a string, and it will never overflow. - * - * @returns {string} an unique alpha-numeric string - */ -function nextUid() { - var index = uid.length; - var digit; - - while(index) { - index--; - digit = uid[index].charCodeAt(0); - if (digit == 57 /*'9'*/) { - uid[index] = 'A'; - return uid.join(''); - } - if (digit == 90 /*'Z'*/) { - uid[index] = '0'; - } else { - uid[index] = String.fromCharCode(digit + 1); - return uid.join(''); - } - } - uid.unshift('0'); - return uid.join(''); -} - - -/** - * Set or clear the hashkey for an object. - * @param obj object - * @param h the hashkey (!truthy to delete the hashkey) - */ -function setHashKey(obj, h) { - if (h) { - obj.$$hashKey = h; - } - else { - delete obj.$$hashKey; - } -} - -/** - * @ngdoc function - * @name angular.extend - * @module ng - * @function - * - * @description - * Extends the destination object `dst` by copying all of the properties from the `src` object(s) - * to `dst`. You can specify multiple `src` objects. - * - * @param {Object} dst Destination object. - * @param {...Object} src Source object(s). - * @returns {Object} Reference to `dst`. - */ -function extend(dst) { - var h = dst.$$hashKey; - forEach(arguments, function(obj){ - if (obj !== dst) { - forEach(obj, function(value, key){ - dst[key] = value; - }); - } - }); - - setHashKey(dst,h); - return dst; -} - -function int(str) { - return parseInt(str, 10); -} - - -function inherit(parent, extra) { - return extend(new (extend(function() {}, {prototype:parent}))(), extra); -} - -/** - * @ngdoc function - * @name angular.noop - * @module ng - * @function - * - * @description - * A function that performs no operations. This function can be useful when writing code in the - * functional style. - ```js - function foo(callback) { - var result = calculateResult(); - (callback || angular.noop)(result); - } - ``` - */ -function noop() {} -noop.$inject = []; - - -/** - * @ngdoc function - * @name angular.identity - * @module ng - * @function - * - * @description - * A function that returns its first argument. This function is useful when writing code in the - * functional style. - * - ```js - function transformer(transformationFn, value) { - return (transformationFn || angular.identity)(value); - }; - ``` - */ -function identity($) {return $;} -identity.$inject = []; - - -function valueFn(value) {return function() {return value;};} - -/** - * @ngdoc function - * @name angular.isUndefined - * @module ng - * @function - * - * @description - * Determines if a reference is undefined. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is undefined. - */ -function isUndefined(value){return typeof value === 'undefined';} - - -/** - * @ngdoc function - * @name angular.isDefined - * @module ng - * @function - * - * @description - * Determines if a reference is defined. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is defined. - */ -function isDefined(value){return typeof value !== 'undefined';} - - -/** - * @ngdoc function - * @name angular.isObject - * @module ng - * @function - * - * @description - * Determines if a reference is an `Object`. Unlike `typeof` in JavaScript, `null`s are not - * considered to be objects. Note that JavaScript arrays are objects. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is an `Object` but not `null`. - */ -function isObject(value){return value != null && typeof value === 'object';} - - -/** - * @ngdoc function - * @name angular.isString - * @module ng - * @function - * - * @description - * Determines if a reference is a `String`. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `String`. - */ -function isString(value){return typeof value === 'string';} - - -/** - * @ngdoc function - * @name angular.isNumber - * @module ng - * @function - * - * @description - * Determines if a reference is a `Number`. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `Number`. - */ -function isNumber(value){return typeof value === 'number';} - - -/** - * @ngdoc function - * @name angular.isDate - * @module ng - * @function - * - * @description - * Determines if a value is a date. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `Date`. - */ -function isDate(value){ - return toString.call(value) === '[object Date]'; -} - - -/** - * @ngdoc function - * @name angular.isArray - * @module ng - * @function - * - * @description - * Determines if a reference is an `Array`. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is an `Array`. - */ -function isArray(value) { - return toString.call(value) === '[object Array]'; -} - - -/** - * @ngdoc function - * @name angular.isFunction - * @module ng - * @function - * - * @description - * Determines if a reference is a `Function`. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `Function`. - */ -function isFunction(value){return typeof value === 'function';} - - -/** - * Determines if a value is a regular expression object. - * - * @private - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a `RegExp`. - */ -function isRegExp(value) { - return toString.call(value) === '[object RegExp]'; -} - - -/** - * Checks if `obj` is a window object. - * - * @private - * @param {*} obj Object to check - * @returns {boolean} True if `obj` is a window obj. - */ -function isWindow(obj) { - return obj && obj.document && obj.location && obj.alert && obj.setInterval; -} - - -function isScope(obj) { - return obj && obj.$evalAsync && obj.$watch; -} - - -function isFile(obj) { - return toString.call(obj) === '[object File]'; -} - - -function isBlob(obj) { - return toString.call(obj) === '[object Blob]'; -} - - -function isBoolean(value) { - return typeof value === 'boolean'; -} - - -var trim = (function() { - // native trim is way faster: http://jsperf.com/angular-trim-test - // but IE doesn't have it... :-( - // TODO: we should move this into IE/ES5 polyfill - if (!String.prototype.trim) { - return function(value) { - return isString(value) ? value.replace(/^\s\s*/, '').replace(/\s\s*$/, '') : value; - }; - } - return function(value) { - return isString(value) ? value.trim() : value; - }; -})(); - - -/** - * @ngdoc function - * @name angular.isElement - * @module ng - * @function - * - * @description - * Determines if a reference is a DOM element (or wrapped jQuery element). - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is a DOM element (or wrapped jQuery element). - */ -function isElement(node) { - return !!(node && - (node.nodeName // we are a direct element - || (node.prop && node.attr && node.find))); // we have an on and find method part of jQuery API -} - -/** - * @param str 'key1,key2,...' - * @returns {object} in the form of {key1:true, key2:true, ...} - */ -function makeMap(str){ - var obj = {}, items = str.split(","), i; - for ( i = 0; i < items.length; i++ ) - obj[ items[i] ] = true; - return obj; -} - - -if (msie < 9) { - nodeName_ = function(element) { - element = element.nodeName ? element : element[0]; - return (element.scopeName && element.scopeName != 'HTML') - ? uppercase(element.scopeName + ':' + element.nodeName) : element.nodeName; - }; -} else { - nodeName_ = function(element) { - return element.nodeName ? element.nodeName : element[0].nodeName; - }; -} - - -function map(obj, iterator, context) { - var results = []; - forEach(obj, function(value, index, list) { - results.push(iterator.call(context, value, index, list)); - }); - return results; -} - - -/** - * @description - * Determines the number of elements in an array, the number of properties an object has, or - * the length of a string. - * - * Note: This function is used to augment the Object type in Angular expressions. See - * {@link angular.Object} for more information about Angular arrays. - * - * @param {Object|Array|string} obj Object, array, or string to inspect. - * @param {boolean} [ownPropsOnly=false] Count only "own" properties in an object - * @returns {number} The size of `obj` or `0` if `obj` is neither an object nor an array. - */ -function size(obj, ownPropsOnly) { - var count = 0, key; - - if (isArray(obj) || isString(obj)) { - return obj.length; - } else if (isObject(obj)){ - for (key in obj) - if (!ownPropsOnly || obj.hasOwnProperty(key)) - count++; - } - - return count; -} - - -function includes(array, obj) { - return indexOf(array, obj) != -1; -} - -function indexOf(array, obj) { - if (array.indexOf) return array.indexOf(obj); - - for (var i = 0; i < array.length; i++) { - if (obj === array[i]) return i; - } - return -1; -} - -function arrayRemove(array, value) { - var index = indexOf(array, value); - if (index >=0) - array.splice(index, 1); - return value; -} - -function isLeafNode (node) { - if (node) { - switch (node.nodeName) { - case "OPTION": - case "PRE": - case "TITLE": - return true; - } - } - return false; -} - -/** - * @ngdoc function - * @name angular.copy - * @module ng - * @function - * - * @description - * Creates a deep copy of `source`, which should be an object or an array. - * - * * If no destination is supplied, a copy of the object or array is created. - * * If a destination is provided, all of its elements (for array) or properties (for objects) - * are deleted and then all elements/properties from the source are copied to it. - * * If `source` is not an object or array (inc. `null` and `undefined`), `source` is returned. - * * If `source` is identical to 'destination' an exception will be thrown. - * - * @param {*} source The source that will be used to make a copy. - * Can be any type, including primitives, `null`, and `undefined`. - * @param {(Object|Array)=} destination Destination into which the source is copied. If - * provided, must be of the same type as `source`. - * @returns {*} The copy or updated `destination`, if `destination` was specified. - * - * @example - - -
-
- Name:
- E-mail:
- Gender: male - female
- - - - 
form = {{user | json}}
- 
master = {{master | json}}
-
- - - - - */ -function copy(source, destination){ - if (isWindow(source) || isScope(source)) { - throw ngMinErr('cpws', - "Can't copy! Making copies of Window or Scope instances is not supported."); - } - - if (!destination) { - destination = source; - if (source) { - if (isArray(source)) { - destination = copy(source, []); - } else if (isDate(source)) { - destination = new Date(source.getTime()); - } else if (isRegExp(source)) { - destination = new RegExp(source.source); - } else if (isObject(source)) { - destination = copy(source, {}); - } - } - } else { - if (source === destination) throw ngMinErr('cpi', - "Can't copy! Source and destination are identical."); - if (isArray(source)) { - destination.length = 0; - for ( var i = 0; i < source.length; i++) { - destination.push(copy(source[i])); - } - } else { - var h = destination.$$hashKey; - forEach(destination, function(value, key){ - delete destination[key]; - }); - for ( var key in source) { - destination[key] = copy(source[key]); - } - setHashKey(destination,h); - } - } - return destination; -} - -/** - * Create a shallow copy of an object - */ -function shallowCopy(src, dst) { - dst = dst || {}; - - for(var key in src) { - // shallowCopy is only ever called by $compile nodeLinkFn, which has control over src - // so we don't need to worry about using our custom hasOwnProperty here - if (src.hasOwnProperty(key) && !(key.charAt(0) === '$' && key.charAt(1) === '$')) { - dst[key] = src[key]; - } - } - - return dst; -} - - -/** - * @ngdoc function - * @name angular.equals - * @module ng - * @function - * - * @description - * Determines if two objects or two values are equivalent. Supports value types, regular - * expressions, arrays and objects. - * - * Two objects or values are considered equivalent if at least one of the following is true: - * - * * Both objects or values pass `===` comparison. - * * Both objects or values are of the same type and all of their properties are equal by - * comparing them with `angular.equals`. - * * Both values are NaN. (In JavaScript, NaN == NaN => false. But we consider two NaN as equal) - * * Both values represent the same regular expression (In JavasScript, - * /abc/ == /abc/ => false. But we consider two regular expressions as equal when their textual - * representation matches). - * - * During a property comparison, properties of `function` type and properties with names - * that begin with `$` are ignored. - * - * Scope and DOMWindow objects are being compared only by identify (`===`). - * - * @param {*} o1 Object or value to compare. - * @param {*} o2 Object or value to compare. - * @returns {boolean} True if arguments are equal. - */ -function equals(o1, o2) { - if (o1 === o2) return true; - if (o1 === null || o2 === null) return false; - if (o1 !== o1 && o2 !== o2) return true; // NaN === NaN - var t1 = typeof o1, t2 = typeof o2, length, key, keySet; - if (t1 == t2) { - if (t1 == 'object') { - if (isArray(o1)) { - if (!isArray(o2)) return false; - if ((length = o1.length) == o2.length) { - for(key=0; key 2 ? sliceArgs(arguments, 2) : []; - if (isFunction(fn) && !(fn instanceof RegExp)) { - return curryArgs.length - ? function() { - return arguments.length - ? fn.apply(self, curryArgs.concat(slice.call(arguments, 0))) - : fn.apply(self, curryArgs); - } - : function() { - return arguments.length - ? fn.apply(self, arguments) - : fn.call(self); - }; - } else { - // in IE, native methods are not functions so they cannot be bound (note: they don't need to be) - return fn; - } -} - - -function toJsonReplacer(key, value) { - var val = value; - - if (typeof key === 'string' && key.charAt(0) === '$') { - val = undefined; - } else if (isWindow(value)) { - val = '$WINDOW'; - } else if (value && document === value) { - val = '$DOCUMENT'; - } else if (isScope(value)) { - val = '$SCOPE'; - } - - return val; -} - - -/** - * @ngdoc function - * @name angular.toJson - * @module ng - * @function - * - * @description - * Serializes input into a JSON-formatted string. Properties with leading $ characters will be - * stripped since angular uses this notation internally. - * - * @param {Object|Array|Date|string|number} obj Input to be serialized into JSON. - * @param {boolean=} pretty If set to true, the JSON output will contain newlines and whitespace. - * @returns {string|undefined} JSON-ified string representing `obj`. - */ -function toJson(obj, pretty) { - if (typeof obj === 'undefined') return undefined; - return JSON.stringify(obj, toJsonReplacer, pretty ? ' ' : null); -} - - -/** - * @ngdoc function - * @name angular.fromJson - * @module ng - * @function - * - * @description - * Deserializes a JSON string. - * - * @param {string} json JSON string to deserialize. - * @returns {Object|Array|string|number} Deserialized thingy. - */ -function fromJson(json) { - return isString(json) - ? JSON.parse(json) - : json; -} - - -function toBoolean(value) { - if (typeof value === 'function') { - value = true; - } else if (value && value.length !== 0) { - var v = lowercase("" + value); - value = !(v == 'f' || v == '0' || v == 'false' || v == 'no' || v == 'n' || v == '[]'); - } else { - value = false; - } - return value; -} - -/** - * @returns {string} Returns the string representation of the element. - */ -function startingTag(element) { - element = jqLite(element).clone(); - try { - // turns out IE does not let you set .html() on elements which - // are not allowed to have children. So we just ignore it. - element.empty(); - } catch(e) {} - // As Per DOM Standards - var TEXT_NODE = 3; - var elemHtml = jqLite('
').append(element).html(); - try { - return element[0].nodeType === TEXT_NODE ? lowercase(elemHtml) : - elemHtml. - match(/^(<[^>]+>)/)[1]. - replace(/^<([\w\-]+)/, function(match, nodeName) { return '<' + lowercase(nodeName); }); - } catch(e) { - return lowercase(elemHtml); - } - -} - - -///////////////////////////////////////////////// - -/** - * Tries to decode the URI component without throwing an exception. - * - * @private - * @param str value potential URI component to check. - * @returns {boolean} True if `value` can be decoded - * with the decodeURIComponent function. - */ -function tryDecodeURIComponent(value) { - try { - return decodeURIComponent(value); - } catch(e) { - // Ignore any invalid uri component - } -} - - -/** - * Parses an escaped url query string into key-value pairs. - * @returns {Object.} - */ -function parseKeyValue(/**string*/keyValue) { - var obj = {}, key_value, key; - forEach((keyValue || "").split('&'), function(keyValue){ - if ( keyValue ) { - key_value = keyValue.split('='); - key = tryDecodeURIComponent(key_value[0]); - if ( isDefined(key) ) { - var val = isDefined(key_value[1]) ? tryDecodeURIComponent(key_value[1]) : true; - if (!obj[key]) { - obj[key] = val; - } else if(isArray(obj[key])) { - obj[key].push(val); - } else { - obj[key] = [obj[key],val]; - } - } - } - }); - return obj; -} - -function toKeyValue(obj) { - var parts = []; - forEach(obj, function(value, key) { - if (isArray(value)) { - forEach(value, function(arrayValue) { - parts.push(encodeUriQuery(key, true) + - (arrayValue === true ? '' : '=' + encodeUriQuery(arrayValue, true))); - }); - } else { - parts.push(encodeUriQuery(key, true) + - (value === true ? '' : '=' + encodeUriQuery(value, true))); - } - }); - return parts.length ? parts.join('&') : ''; -} - - -/** - * We need our custom method because encodeURIComponent is too aggressive and doesn't follow - * http://www.ietf.org/rfc/rfc3986.txt with regards to the character set (pchar) allowed in path - * segments: - * segment = *pchar - * pchar = unreserved / pct-encoded / sub-delims / ":" / "@" - * pct-encoded = "%" HEXDIG HEXDIG - * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" - * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" - * / "*" / "+" / "," / ";" / "=" - */ -function encodeUriSegment(val) { - return encodeUriQuery(val, true). - replace(/%26/gi, '&'). - replace(/%3D/gi, '='). - replace(/%2B/gi, '+'); -} - - -/** - * This method is intended for encoding *key* or *value* parts of query component. We need a custom - * method because encodeURIComponent is too aggressive and encodes stuff that doesn't have to be - * encoded per http://tools.ietf.org/html/rfc3986: - * query = *( pchar / "/" / "?" ) - * pchar = unreserved / pct-encoded / sub-delims / ":" / "@" - * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" - * pct-encoded = "%" HEXDIG HEXDIG - * sub-delims = "!" / "$" / "&" / "'" / "(" / ")" - * / "*" / "+" / "," / ";" / "=" - */ -function encodeUriQuery(val, pctEncodeSpaces) { - return encodeURIComponent(val). - replace(/%40/gi, '@'). - replace(/%3A/gi, ':'). - replace(/%24/g, '$'). - replace(/%2C/gi, ','). - replace(/%20/g, (pctEncodeSpaces ? '%20' : '+')); -} - - -/** - * @ngdoc directive - * @name ngApp - * @module ng - * - * @element ANY - * @param {angular.Module} ngApp an optional application - * {@link angular.module module} name to load. - * - * @description - * - * Use this directive to **auto-bootstrap** an AngularJS application. The `ngApp` directive - * designates the **root element** of the application and is typically placed near the root element - * of the page - e.g. on the `` or `` tags. - * - * Only one AngularJS application can be auto-bootstrapped per HTML document. The first `ngApp` - * found in the document will be used to define the root element to auto-bootstrap as an - * application. To run multiple applications in an HTML document you must manually bootstrap them using - * {@link angular.bootstrap} instead. AngularJS applications cannot be nested within each other. - * - * You can specify an **AngularJS module** to be used as the root module for the application. This - * module will be loaded into the {@link auto.$injector} when the application is bootstrapped and - * should contain the application code needed or have dependencies on other modules that will - * contain the code. See {@link angular.module} for more information. - * - * In the example below if the `ngApp` directive were not placed on the `html` element then the - * document would not be compiled, the `AppController` would not be instantiated and the `{{ a+b }}` - * would not be resolved to `3`. - * - * `ngApp` is the easiest, and most common, way to bootstrap an application. - * - - -
- I can add: {{a}} + {{b}} = {{ a+b }} -
- - - angular.module('ngAppDemo', []).controller('ngAppDemoController', function($scope) { - $scope.a = 1; - $scope.b = 2; - }); - - - * - */ -function angularInit(element, bootstrap) { - var elements = [element], - appElement, - module, - names = ['ng:app', 'ng-app', 'x-ng-app', 'data-ng-app'], - NG_APP_CLASS_REGEXP = /\sng[:\-]app(:\s*([\w\d_]+);?)?\s/; - - function append(element) { - element && elements.push(element); - } - - forEach(names, function(name) { - names[name] = true; - append(document.getElementById(name)); - name = name.replace(':', '\\:'); - if (element.querySelectorAll) { - forEach(element.querySelectorAll('.' + name), append); - forEach(element.querySelectorAll('.' + name + '\\:'), append); - forEach(element.querySelectorAll('[' + name + ']'), append); - } - }); - - forEach(elements, function(element) { - if (!appElement) { - var className = ' ' + element.className + ' '; - var match = NG_APP_CLASS_REGEXP.exec(className); - if (match) { - appElement = element; - module = (match[2] || '').replace(/\s+/g, ','); - } else { - forEach(element.attributes, function(attr) { - if (!appElement && names[attr.name]) { - appElement = element; - module = attr.value; - } - }); - } - } - }); - if (appElement) { - bootstrap(appElement, module ? [module] : []); - } -} - -/** - * @ngdoc function - * @name angular.bootstrap - * @module ng - * @description - * Use this function to manually start up angular application. - * - * See: {@link guide/bootstrap Bootstrap} - * - * Note that ngScenario-based end-to-end tests cannot use this function to bootstrap manually. - * They must use {@link ng.directive:ngApp ngApp}. - * - * Angular will detect if it has been loaded into the browser more than once and only allow the - * first loaded script to be bootstrapped and will report a warning to the browser console for - * each of the subsequent scripts. This prevents strange results in applications, where otherwise - * multiple instances of Angular try to work on the DOM. - * - * - * - * - *
- *

Login

Username:
Password:
- * - * - * - * - * - * - *
{{heading}}
{{fill}}
- * - * - * - * var app = angular.module('multi-bootstrap', []) - * - * .controller('BrokenTable', function($scope) { - * $scope.headings = ['One', 'Two', 'Three']; - * $scope.fillings = [[1, 2, 3], ['A', 'B', 'C'], [7, 8, 9]]; - * }); - * - * - * it('should only insert one table cell for each item in $scope.fillings', function() { - * expect(element.all(by.css('td')).count()) - * .toBe(9); - * }); - * - * - * - * @param {DOMElement} element DOM element which is the root of angular application. - * @param {Array=} modules an array of modules to load into the application. - * Each item in the array should be the name of a predefined module or a (DI annotated) - * function that will be invoked by the injector as a run block. - * See: {@link angular.module modules} - * @returns {auto.$injector} Returns the newly created injector for this app. - */ -function bootstrap(element, modules) { - var doBootstrap = function() { - element = jqLite(element); - - if (element.injector()) { - var tag = (element[0] === document) ? 'document' : startingTag(element); - throw ngMinErr('btstrpd', "App Already Bootstrapped with this Element '{0}'", tag); - } - - modules = modules || []; - modules.unshift(['$provide', function($provide) { - $provide.value('$rootElement', element); - }]); - modules.unshift('ng'); - var injector = createInjector(modules); - injector.invoke(['$rootScope', '$rootElement', '$compile', '$injector', '$animate', - function(scope, element, compile, injector, animate) { - scope.$apply(function() { - element.data('$injector', injector); - compile(element)(scope); - }); - }] - ); - return injector; - }; - - var NG_DEFER_BOOTSTRAP = /^NG_DEFER_BOOTSTRAP!/; - - if (window && !NG_DEFER_BOOTSTRAP.test(window.name)) { - return doBootstrap(); - } - - window.name = window.name.replace(NG_DEFER_BOOTSTRAP, ''); - angular.resumeBootstrap = function(extraModules) { - forEach(extraModules, function(module) { - modules.push(module); - }); - doBootstrap(); - }; -} - -var SNAKE_CASE_REGEXP = /[A-Z]/g; -function snake_case(name, separator){ - separator = separator || '_'; - return name.replace(SNAKE_CASE_REGEXP, function(letter, pos) { - return (pos ? separator : '') + letter.toLowerCase(); - }); -} - -function bindJQuery() { - // bind to jQuery if present; - jQuery = window.jQuery; - // reset to jQuery or default to us. - if (jQuery) { - jqLite = jQuery; - extend(jQuery.fn, { - scope: JQLitePrototype.scope, - isolateScope: JQLitePrototype.isolateScope, - controller: JQLitePrototype.controller, - injector: JQLitePrototype.injector, - inheritedData: JQLitePrototype.inheritedData - }); - // Method signature: - // jqLitePatchJQueryRemove(name, dispatchThis, filterElems, getterIfNoArguments) - jqLitePatchJQueryRemove('remove', true, true, false); - jqLitePatchJQueryRemove('empty', false, false, false); - jqLitePatchJQueryRemove('html', false, false, true); - } else { - jqLite = JQLite; - } - angular.element = jqLite; -} - -/** - * throw error if the argument is falsy. - */ -function assertArg(arg, name, reason) { - if (!arg) { - throw ngMinErr('areq', "Argument '{0}' is {1}", (name || '?'), (reason || "required")); - } - return arg; -} - -function assertArgFn(arg, name, acceptArrayAnnotation) { - if (acceptArrayAnnotation && isArray(arg)) { - arg = arg[arg.length - 1]; - } - - assertArg(isFunction(arg), name, 'not a function, got ' + - (arg && typeof arg == 'object' ? arg.constructor.name || 'Object' : typeof arg)); - return arg; -} - -/** - * throw error if the name given is hasOwnProperty - * @param {String} name the name to test - * @param {String} context the context in which the name is used, such as module or directive - */ -function assertNotHasOwnProperty(name, context) { - if (name === 'hasOwnProperty') { - throw ngMinErr('badname', "hasOwnProperty is not a valid {0} name", context); - } -} - -/** - * Return the value accessible from the object by path. Any undefined traversals are ignored - * @param {Object} obj starting object - * @param {String} path path to traverse - * @param {boolean} [bindFnToScope=true] - * @returns {Object} value as accessible by path - */ -//TODO(misko): this function needs to be removed -function getter(obj, path, bindFnToScope) { - if (!path) return obj; - var keys = path.split('.'); - var key; - var lastInstance = obj; - var len = keys.length; - - for (var i = 0; i < len; i++) { - key = keys[i]; - if (obj) { - obj = (lastInstance = obj)[key]; - } - } - if (!bindFnToScope && isFunction(obj)) { - return bind(lastInstance, obj); - } - return obj; -} - -/** - * Return the DOM siblings between the first and last node in the given array. - * @param {Array} array like object - * @returns {DOMElement} object containing the elements - */ -function getBlockElements(nodes) { - var startNode = nodes[0], - endNode = nodes[nodes.length - 1]; - if (startNode === endNode) { - return jqLite(startNode); - } - - var element = startNode; - var elements = [element]; - - do { - element = element.nextSibling; - if (!element) break; - elements.push(element); - } while (element !== endNode); - - return jqLite(elements); -} - -/** - * @ngdoc type - * @name angular.Module - * @module ng - * @description - * - * Interface for configuring angular {@link angular.module modules}. - */ - -function setupModuleLoader(window) { - - var $injectorMinErr = minErr('$injector'); - var ngMinErr = minErr('ng'); - - function ensure(obj, name, factory) { - return obj[name] || (obj[name] = factory()); - } - - var angular = ensure(window, 'angular', Object); - - // We need to expose `angular.$$minErr` to modules such as `ngResource` that reference it during bootstrap - angular.$$minErr = angular.$$minErr || minErr; - - return ensure(angular, 'module', function() { - /** @type {Object.} */ - var modules = {}; - - /** - * @ngdoc function - * @name angular.module - * @module ng - * @description - * - * The `angular.module` is a global place for creating, registering and retrieving Angular - * modules. - * All modules (angular core or 3rd party) that should be available to an application must be - * registered using this mechanism. - * - * When passed two or more arguments, a new module is created. If passed only one argument, an - * existing module (the name passed as the first argument to `module`) is retrieved. - * - * - * # Module - * - * A module is a collection of services, directives, filters, and configuration information. - * `angular.module` is used to configure the {@link auto.$injector $injector}. - * - * ```js - * // Create a new module - * var myModule = angular.module('myModule', []); - * - * // register a new service - * myModule.value('appName', 'MyCoolApp'); - * - * // configure existing services inside initialization blocks. - * myModule.config(['$locationProvider', function($locationProvider) { - * // Configure existing providers - * $locationProvider.hashPrefix('!'); - * }]); - * ``` - * - * Then you can create an injector and load your modules like this: - * - * ```js - * var injector = angular.injector(['ng', 'myModule']) - * ``` - * - * However it's more likely that you'll just use - * {@link ng.directive:ngApp ngApp} or - * {@link angular.bootstrap} to simplify this process for you. - * - * @param {!string} name The name of the module to create or retrieve. -<<<<<* @param {!Array.=} requires If specified then new module is being created. If ->>>>>* unspecified then the module is being retrieved for further configuration. - * @param {Function} configFn Optional configuration function for the module. Same as - * {@link angular.Module#config Module#config()}. - * @returns {module} new module with the {@link angular.Module} api. - */ - return function module(name, requires, configFn) { - var assertNotHasOwnProperty = function(name, context) { - if (name === 'hasOwnProperty') { - throw ngMinErr('badname', 'hasOwnProperty is not a valid {0} name', context); - } - }; - - assertNotHasOwnProperty(name, 'module'); - if (requires && modules.hasOwnProperty(name)) { - modules[name] = null; - } - return ensure(modules, name, function() { - if (!requires) { - throw $injectorMinErr('nomod', "Module '{0}' is not available! You either misspelled " + - "the module name or forgot to load it. If registering a module ensure that you " + - "specify the dependencies as the second argument.", name); - } - - /** @type {!Array.>} */ - var invokeQueue = []; - - /** @type {!Array.} */ - var runBlocks = []; - - var config = invokeLater('$injector', 'invoke'); - - /** @type {angular.Module} */ - var moduleInstance = { - // Private state - _invokeQueue: invokeQueue, - _runBlocks: runBlocks, - - /** - * @ngdoc property - * @name angular.Module#requires - * @module ng - * @returns {Array.} List of module names which must be loaded before this module. - * @description - * Holds the list of modules which the injector will load before the current module is - * loaded. - */ - requires: requires, - - /** - * @ngdoc property - * @name angular.Module#name - * @module ng - * @returns {string} Name of the module. - * @description - */ - name: name, - - - /** - * @ngdoc method - * @name angular.Module#provider - * @module ng - * @param {string} name service name - * @param {Function} providerType Construction function for creating new instance of the - * service. - * @description - * See {@link auto.$provide#provider $provide.provider()}. - */ - provider: invokeLater('$provide', 'provider'), - - /** - * @ngdoc method - * @name angular.Module#factory - * @module ng - * @param {string} name service name - * @param {Function} providerFunction Function for creating new instance of the service. - * @description - * See {@link auto.$provide#factory $provide.factory()}. - */ - factory: invokeLater('$provide', 'factory'), - - /** - * @ngdoc method - * @name angular.Module#service - * @module ng - * @param {string} name service name - * @param {Function} constructor A constructor function that will be instantiated. - * @description - * See {@link auto.$provide#service $provide.service()}. - */ - service: invokeLater('$provide', 'service'), - - /** - * @ngdoc method - * @name angular.Module#value - * @module ng - * @param {string} name service name - * @param {*} object Service instance object. - * @description - * See {@link auto.$provide#value $provide.value()}. - */ - value: invokeLater('$provide', 'value'), - - /** - * @ngdoc method - * @name angular.Module#constant - * @module ng - * @param {string} name constant name - * @param {*} object Constant value. - * @description - * Because the constant are fixed, they get applied before other provide methods. - * See {@link auto.$provide#constant $provide.constant()}. - */ - constant: invokeLater('$provide', 'constant', 'unshift'), - - /** - * @ngdoc method - * @name angular.Module#animation - * @module ng - * @param {string} name animation name - * @param {Function} animationFactory Factory function for creating new instance of an - * animation. - * @description - * - * **NOTE**: animations take effect only if the **ngAnimate** module is loaded. - * - * - * Defines an animation hook that can be later used with - * {@link ngAnimate.$animate $animate} service and directives that use this service. - * - * ```js - * module.animation('.animation-name', function($inject1, $inject2) { - * return { - * eventName : function(element, done) { - * //code to run the animation - * //once complete, then run done() - * return function cancellationFunction(element) { - * //code to cancel the animation - * } - * } - * } - * }) - * ``` - * - * See {@link ngAnimate.$animateProvider#register $animateProvider.register()} and - * {@link ngAnimate ngAnimate module} for more information. - */ - animation: invokeLater('$animateProvider', 'register'), - - /** - * @ngdoc method - * @name angular.Module#filter - * @module ng - * @param {string} name Filter name. - * @param {Function} filterFactory Factory function for creating new instance of filter. - * @description - * See {@link ng.$filterProvider#register $filterProvider.register()}. - */ - filter: invokeLater('$filterProvider', 'register'), - - /** - * @ngdoc method - * @name angular.Module#controller - * @module ng - * @param {string|Object} name Controller name, or an object map of controllers where the - * keys are the names and the values are the constructors. - * @param {Function} constructor Controller constructor function. - * @description - * See {@link ng.$controllerProvider#register $controllerProvider.register()}. - */ - controller: invokeLater('$controllerProvider', 'register'), - - /** - * @ngdoc method - * @name angular.Module#directive - * @module ng - * @param {string|Object} name Directive name, or an object map of directives where the - * keys are the names and the values are the factories. - * @param {Function} directiveFactory Factory function for creating new instance of - * directives. - * @description - * See {@link ng.$compileProvider#directive $compileProvider.directive()}. - */ - directive: invokeLater('$compileProvider', 'directive'), - - /** - * @ngdoc method - * @name angular.Module#config - * @module ng - * @param {Function} configFn Execute this function on module load. Useful for service - * configuration. - * @description - * Use this method to register work which needs to be performed on module loading. - */ - config: config, - - /** - * @ngdoc method - * @name angular.Module#run - * @module ng - * @param {Function} initializationFn Execute this function after injector creation. - * Useful for application initialization. - * @description - * Use this method to register work which should be performed when the injector is done - * loading all modules. - */ - run: function(block) { - runBlocks.push(block); - return this; - } - }; - - if (configFn) { - config(configFn); - } - - return moduleInstance; - - /** - * @param {string} provider - * @param {string} method - * @param {String=} insertMethod - * @returns {angular.Module} - */ - function invokeLater(provider, method, insertMethod) { - return function() { - invokeQueue[insertMethod || 'push']([provider, method, arguments]); - return moduleInstance; - }; - } - }); - }; - }); - -} - -/* global - angularModule: true, - version: true, - - $LocaleProvider, - $CompileProvider, - - htmlAnchorDirective, - inputDirective, - inputDirective, - formDirective, - scriptDirective, - selectDirective, - styleDirective, - optionDirective, - ngBindDirective, - ngBindHtmlDirective, - ngBindTemplateDirective, - ngClassDirective, - ngClassEvenDirective, - ngClassOddDirective, - ngCspDirective, - ngCloakDirective, - ngControllerDirective, - ngFormDirective, - ngHideDirective, - ngIfDirective, - ngIncludeDirective, - ngIncludeFillContentDirective, - ngInitDirective, - ngNonBindableDirective, - ngPluralizeDirective, - ngRepeatDirective, - ngShowDirective, - ngStyleDirective, - ngSwitchDirective, - ngSwitchWhenDirective, - ngSwitchDefaultDirective, - ngOptionsDirective, - ngTranscludeDirective, - ngModelDirective, - ngListDirective, - ngChangeDirective, - requiredDirective, - requiredDirective, - ngValueDirective, - ngAttributeAliasDirectives, - ngEventDirectives, - - $AnchorScrollProvider, - $AnimateProvider, - $BrowserProvider, - $CacheFactoryProvider, - $ControllerProvider, - $DocumentProvider, - $ExceptionHandlerProvider, - $FilterProvider, - $InterpolateProvider, - $IntervalProvider, - $HttpProvider, - $HttpBackendProvider, - $LocationProvider, - $LogProvider, - $ParseProvider, - $RootScopeProvider, - $QProvider, - $$SanitizeUriProvider, - $SceProvider, - $SceDelegateProvider, - $SnifferProvider, - $TemplateCacheProvider, - $TimeoutProvider, - $$RAFProvider, - $$AsyncCallbackProvider, - $WindowProvider -*/ - - -/** - * @ngdoc object - * @name angular.version - * @module ng - * @description - * An object that contains information about the current AngularJS version. This object has the - * following properties: - * - * - `full` – `{string}` – Full version string, such as "0.9.18". - * - `major` – `{number}` – Major version number, such as "0". - * - `minor` – `{number}` – Minor version number, such as "9". - * - `dot` – `{number}` – Dot version number, such as "18". - * - `codeName` – `{string}` – Code name of the release, such as "jiggling-armfat". - */ -var version = { - full: '1.2.16', // all of these placeholder strings will be replaced by grunt's - major: 1, // package task - minor: 2, - dot: 16, - codeName: 'badger-enumeration' -}; - - -function publishExternalAPI(angular){ - extend(angular, { - 'bootstrap': bootstrap, - 'copy': copy, - 'extend': extend, - 'equals': equals, - 'element': jqLite, - 'forEach': forEach, - 'injector': createInjector, - 'noop':noop, - 'bind':bind, - 'toJson': toJson, - 'fromJson': fromJson, - 'identity':identity, - 'isUndefined': isUndefined, - 'isDefined': isDefined, - 'isString': isString, - 'isFunction': isFunction, - 'isObject': isObject, - 'isNumber': isNumber, - 'isElement': isElement, - 'isArray': isArray, - 'version': version, - 'isDate': isDate, - 'lowercase': lowercase, - 'uppercase': uppercase, - 'callbacks': {counter: 0}, - '$$minErr': minErr, - '$$csp': csp - }); - - angularModule = setupModuleLoader(window); - try { - angularModule('ngLocale'); - } catch (e) { - angularModule('ngLocale', []).provider('$locale', $LocaleProvider); - } - - angularModule('ng', ['ngLocale'], ['$provide', - function ngModule($provide) { - // $$sanitizeUriProvider needs to be before $compileProvider as it is used by it. - $provide.provider({ - $$sanitizeUri: $$SanitizeUriProvider - }); - $provide.provider('$compile', $CompileProvider). - directive({ - a: htmlAnchorDirective, - input: inputDirective, - textarea: inputDirective, - form: formDirective, - script: scriptDirective, - select: selectDirective, - style: styleDirective, - option: optionDirective, - ngBind: ngBindDirective, - ngBindHtml: ngBindHtmlDirective, - ngBindTemplate: ngBindTemplateDirective, - ngClass: ngClassDirective, - ngClassEven: ngClassEvenDirective, - ngClassOdd: ngClassOddDirective, - ngCloak: ngCloakDirective, - ngController: ngControllerDirective, - ngForm: ngFormDirective, - ngHide: ngHideDirective, - ngIf: ngIfDirective, - ngInclude: ngIncludeDirective, - ngInit: ngInitDirective, - ngNonBindable: ngNonBindableDirective, - ngPluralize: ngPluralizeDirective, - ngRepeat: ngRepeatDirective, - ngShow: ngShowDirective, - ngStyle: ngStyleDirective, - ngSwitch: ngSwitchDirective, - ngSwitchWhen: ngSwitchWhenDirective, - ngSwitchDefault: ngSwitchDefaultDirective, - ngOptions: ngOptionsDirective, - ngTransclude: ngTranscludeDirective, - ngModel: ngModelDirective, - ngList: ngListDirective, - ngChange: ngChangeDirective, - required: requiredDirective, - ngRequired: requiredDirective, - ngValue: ngValueDirective - }). - directive({ - ngInclude: ngIncludeFillContentDirective - }). - directive(ngAttributeAliasDirectives). - directive(ngEventDirectives); - $provide.provider({ - $anchorScroll: $AnchorScrollProvider, - $animate: $AnimateProvider, - $browser: $BrowserProvider, - $cacheFactory: $CacheFactoryProvider, - $controller: $ControllerProvider, - $document: $DocumentProvider, - $exceptionHandler: $ExceptionHandlerProvider, - $filter: $FilterProvider, - $interpolate: $InterpolateProvider, - $interval: $IntervalProvider, - $http: $HttpProvider, - $httpBackend: $HttpBackendProvider, - $location: $LocationProvider, - $log: $LogProvider, - $parse: $ParseProvider, - $rootScope: $RootScopeProvider, - $q: $QProvider, - $sce: $SceProvider, - $sceDelegate: $SceDelegateProvider, - $sniffer: $SnifferProvider, - $templateCache: $TemplateCacheProvider, - $timeout: $TimeoutProvider, - $window: $WindowProvider, - $$rAF: $$RAFProvider, - $$asyncCallback : $$AsyncCallbackProvider - }); - } - ]); -} - -/* global - - -JQLitePrototype, - -addEventListenerFn, - -removeEventListenerFn, - -BOOLEAN_ATTR -*/ - -////////////////////////////////// -//JQLite -////////////////////////////////// - -/** - * @ngdoc function - * @name angular.element - * @module ng - * @function - * - * @description - * Wraps a raw DOM element or HTML string as a [jQuery](http://jquery.com) element. - * - * If jQuery is available, `angular.element` is an alias for the - * [jQuery](http://api.jquery.com/jQuery/) function. If jQuery is not available, `angular.element` - * delegates to Angular's built-in subset of jQuery, called "jQuery lite" or "jqLite." - * - *
jqLite is a tiny, API-compatible subset of jQuery that allows - * Angular to manipulate the DOM in a cross-browser compatible way. **jqLite** implements only the most - * commonly needed functionality with the goal of having a very small footprint.
- * - * To use jQuery, simply load it before `DOMContentLoaded` event fired. - * - *
**Note:** all element references in Angular are always wrapped with jQuery or - * jqLite; they are never raw DOM references.
- * - * ## Angular's jqLite - * jqLite provides only the following jQuery methods: - * - * - [`addClass()`](http://api.jquery.com/addClass/) - * - [`after()`](http://api.jquery.com/after/) - * - [`append()`](http://api.jquery.com/append/) - * - [`attr()`](http://api.jquery.com/attr/) - * - [`bind()`](http://api.jquery.com/bind/) - Does not support namespaces, selectors or eventData - * - [`children()`](http://api.jquery.com/children/) - Does not support selectors - * - [`clone()`](http://api.jquery.com/clone/) - * - [`contents()`](http://api.jquery.com/contents/) - * - [`css()`](http://api.jquery.com/css/) - * - [`data()`](http://api.jquery.com/data/) - * - [`empty()`](http://api.jquery.com/empty/) - * - [`eq()`](http://api.jquery.com/eq/) - * - [`find()`](http://api.jquery.com/find/) - Limited to lookups by tag name - * - [`hasClass()`](http://api.jquery.com/hasClass/) - * - [`html()`](http://api.jquery.com/html/) - * - [`next()`](http://api.jquery.com/next/) - Does not support selectors - * - [`on()`](http://api.jquery.com/on/) - Does not support namespaces, selectors or eventData - * - [`off()`](http://api.jquery.com/off/) - Does not support namespaces or selectors - * - [`one()`](http://api.jquery.com/one/) - Does not support namespaces or selectors - * - [`parent()`](http://api.jquery.com/parent/) - Does not support selectors - * - [`prepend()`](http://api.jquery.com/prepend/) - * - [`prop()`](http://api.jquery.com/prop/) - * - [`ready()`](http://api.jquery.com/ready/) - * - [`remove()`](http://api.jquery.com/remove/) - * - [`removeAttr()`](http://api.jquery.com/removeAttr/) - * - [`removeClass()`](http://api.jquery.com/removeClass/) - * - [`removeData()`](http://api.jquery.com/removeData/) - * - [`replaceWith()`](http://api.jquery.com/replaceWith/) - * - [`text()`](http://api.jquery.com/text/) - * - [`toggleClass()`](http://api.jquery.com/toggleClass/) - * - [`triggerHandler()`](http://api.jquery.com/triggerHandler/) - Passes a dummy event object to handlers. - * - [`unbind()`](http://api.jquery.com/unbind/) - Does not support namespaces - * - [`val()`](http://api.jquery.com/val/) - * - [`wrap()`](http://api.jquery.com/wrap/) - * - * ## jQuery/jqLite Extras - * Angular also provides the following additional methods and events to both jQuery and jqLite: - * - * ### Events - * - `$destroy` - AngularJS intercepts all jqLite/jQuery's DOM destruction apis and fires this event - * on all DOM nodes being removed. This can be used to clean up any 3rd party bindings to the DOM - * element before it is removed. - * - * ### Methods - * - `controller(name)` - retrieves the controller of the current element or its parent. By default - * retrieves controller associated with the `ngController` directive. If `name` is provided as - * camelCase directive name, then the controller for this directive will be retrieved (e.g. - * `'ngModel'`). - * - `injector()` - retrieves the injector of the current element or its parent. - * - `scope()` - retrieves the {@link ng.$rootScope.Scope scope} of the current - * element or its parent. - * - `isolateScope()` - retrieves an isolate {@link ng.$rootScope.Scope scope} if one is attached directly to the - * current element. This getter should be used only on elements that contain a directive which starts a new isolate - * scope. Calling `scope()` on this element always returns the original non-isolate scope. - * - `inheritedData()` - same as `data()`, but walks up the DOM until a value is found or the top - * parent element is reached. - * - * @param {string|DOMElement} element HTML string or DOMElement to be wrapped into jQuery. - * @returns {Object} jQuery object. - */ - -var jqCache = JQLite.cache = {}, - jqName = JQLite.expando = 'ng-' + new Date().getTime(), - jqId = 1, - addEventListenerFn = (window.document.addEventListener - ? function(element, type, fn) {element.addEventListener(type, fn, false);} - : function(element, type, fn) {element.attachEvent('on' + type, fn);}), - removeEventListenerFn = (window.document.removeEventListener - ? function(element, type, fn) {element.removeEventListener(type, fn, false); } - : function(element, type, fn) {element.detachEvent('on' + type, fn); }); - -/* - * !!! This is an undocumented "private" function !!! - */ -var jqData = JQLite._data = function(node) { - //jQuery always returns an object on cache miss - return this.cache[node[this.expando]] || {}; -}; - -function jqNextId() { return ++jqId; } - - -var SPECIAL_CHARS_REGEXP = /([\:\-\_]+(.))/g; -var MOZ_HACK_REGEXP = /^moz([A-Z])/; -var jqLiteMinErr = minErr('jqLite'); - -/** - * Converts snake_case to camelCase. - * Also there is special case for Moz prefix starting with upper case letter. - * @param name Name to normalize - */ -function camelCase(name) { - return name. - replace(SPECIAL_CHARS_REGEXP, function(_, separator, letter, offset) { - return offset ? letter.toUpperCase() : letter; - }). - replace(MOZ_HACK_REGEXP, 'Moz$1'); -} - -///////////////////////////////////////////// -// jQuery mutation patch -// -// In conjunction with bindJQuery intercepts all jQuery's DOM destruction apis and fires a -// $destroy event on all DOM nodes being removed. -// -///////////////////////////////////////////// - -function jqLitePatchJQueryRemove(name, dispatchThis, filterElems, getterIfNoArguments) { - var originalJqFn = jQuery.fn[name]; - originalJqFn = originalJqFn.$original || originalJqFn; - removePatch.$original = originalJqFn; - jQuery.fn[name] = removePatch; - - function removePatch(param) { - // jshint -W040 - var list = filterElems && param ? [this.filter(param)] : [this], - fireEvent = dispatchThis, - set, setIndex, setLength, - element, childIndex, childLength, children; - - if (!getterIfNoArguments || param != null) { - while(list.length) { - set = list.shift(); - for(setIndex = 0, setLength = set.length; setIndex < setLength; setIndex++) { - element = jqLite(set[setIndex]); - if (fireEvent) { - element.triggerHandler('$destroy'); - } else { - fireEvent = !fireEvent; - } - for(childIndex = 0, childLength = (children = element.children()).length; - childIndex < childLength; - childIndex++) { - list.push(jQuery(children[childIndex])); - } - } - } - } - return originalJqFn.apply(this, arguments); - } -} - -var SINGLE_TAG_REGEXP = /^<(\w+)\s*\/?>(?:<\/\1>|)$/; -var HTML_REGEXP = /<|&#?\w+;/; -var TAG_NAME_REGEXP = /<([\w:]+)/; -var XHTML_TAG_REGEXP = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi; - -var wrapMap = { - 'option': [1, ''], - - 'thead': [1, '', '
'], - 'col': [2, '', '
'], - 'tr': [2, '', '
'], - 'td': [3, '', '
'], - '_default': [0, "", ""] -}; - -wrapMap.optgroup = wrapMap.option; -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - -function jqLiteIsTextNode(html) { - return !HTML_REGEXP.test(html); -} - -function jqLiteBuildFragment(html, context) { - var elem, tmp, tag, wrap, - fragment = context.createDocumentFragment(), - nodes = [], i, j, jj; - - if (jqLiteIsTextNode(html)) { - // Convert non-html into a text node - nodes.push(context.createTextNode(html)); - } else { - tmp = fragment.appendChild(context.createElement('div')); - // Convert html into DOM nodes - tag = (TAG_NAME_REGEXP.exec(html) || ["", ""])[1].toLowerCase(); - wrap = wrapMap[tag] || wrapMap._default; - tmp.innerHTML = '
 
' + - wrap[1] + html.replace(XHTML_TAG_REGEXP, "<$1>") + wrap[2]; - tmp.removeChild(tmp.firstChild); - - // Descend through wrappers to the right content - i = wrap[0]; - while (i--) { - tmp = tmp.lastChild; - } - - for (j=0, jj=tmp.childNodes.length; j -1); -} - -function jqLiteRemoveClass(element, cssClasses) { - if (cssClasses && element.setAttribute) { - forEach(cssClasses.split(' '), function(cssClass) { - element.setAttribute('class', trim( - (" " + (element.getAttribute('class') || '') + " ") - .replace(/[\n\t]/g, " ") - .replace(" " + trim(cssClass) + " ", " ")) - ); - }); - } -} - -function jqLiteAddClass(element, cssClasses) { - if (cssClasses && element.setAttribute) { - var existingClasses = (' ' + (element.getAttribute('class') || '') + ' ') - .replace(/[\n\t]/g, " "); - - forEach(cssClasses.split(' '), function(cssClass) { - cssClass = trim(cssClass); - if (existingClasses.indexOf(' ' + cssClass + ' ') === -1) { - existingClasses += cssClass + ' '; - } - }); - - element.setAttribute('class', trim(existingClasses)); - } -} - -function jqLiteAddNodes(root, elements) { - if (elements) { - elements = (!elements.nodeName && isDefined(elements.length) && !isWindow(elements)) - ? elements - : [ elements ]; - for(var i=0; i < elements.length; i++) { - root.push(elements[i]); - } - } -} - -function jqLiteController(element, name) { - return jqLiteInheritedData(element, '$' + (name || 'ngController' ) + 'Controller'); -} - -function jqLiteInheritedData(element, name, value) { - element = jqLite(element); - - // if element is the document object work with the html element instead - // this makes $(document).scope() possible - if(element[0].nodeType == 9) { - element = element.find('html'); - } - var names = isArray(name) ? name : [name]; - - while (element.length) { - var node = element[0]; - for (var i = 0, ii = names.length; i < ii; i++) { - if ((value = element.data(names[i])) !== undefined) return value; - } - - // If dealing with a document fragment node with a host element, and no parent, use the host - // element as the parent. This enables directives within a Shadow DOM or polyfilled Shadow DOM - // to lookup parent controllers. - element = jqLite(node.parentNode || (node.nodeType === 11 && node.host)); - } -} - -function jqLiteEmpty(element) { - for (var i = 0, childNodes = element.childNodes; i < childNodes.length; i++) { - jqLiteDealoc(childNodes[i]); - } - while (element.firstChild) { - element.removeChild(element.firstChild); - } -} - -////////////////////////////////////////// -// Functions which are declared directly. -////////////////////////////////////////// -var JQLitePrototype = JQLite.prototype = { - ready: function(fn) { - var fired = false; - - function trigger() { - if (fired) return; - fired = true; - fn(); - } - - // check if document already is loaded - if (document.readyState === 'complete'){ - setTimeout(trigger); - } else { - this.on('DOMContentLoaded', trigger); // works for modern browsers and IE9 - // we can not use jqLite since we are not done loading and jQuery could be loaded later. - // jshint -W064 - JQLite(window).on('load', trigger); // fallback to window.onload for others - // jshint +W064 - } - }, - toString: function() { - var value = []; - forEach(this, function(e){ value.push('' + e);}); - return '[' + value.join(', ') + ']'; - }, - - eq: function(index) { - return (index >= 0) ? jqLite(this[index]) : jqLite(this[this.length + index]); - }, - - length: 0, - push: push, - sort: [].sort, - splice: [].splice -}; - -////////////////////////////////////////// -// Functions iterating getter/setters. -// these functions return self on setter and -// value on get. -////////////////////////////////////////// -var BOOLEAN_ATTR = {}; -forEach('multiple,selected,checked,disabled,readOnly,required,open'.split(','), function(value) { - BOOLEAN_ATTR[lowercase(value)] = value; -}); -var BOOLEAN_ELEMENTS = {}; -forEach('input,select,option,textarea,button,form,details'.split(','), function(value) { - BOOLEAN_ELEMENTS[uppercase(value)] = true; -}); - -function getBooleanAttrName(element, name) { - // check dom last since we will most likely fail on name - var booleanAttr = BOOLEAN_ATTR[name.toLowerCase()]; - - // booleanAttr is here twice to minimize DOM access - return booleanAttr && BOOLEAN_ELEMENTS[element.nodeName] && booleanAttr; -} - -forEach({ - data: jqLiteData, - inheritedData: jqLiteInheritedData, - - scope: function(element) { - // Can't use jqLiteData here directly so we stay compatible with jQuery! - return jqLite(element).data('$scope') || jqLiteInheritedData(element.parentNode || element, ['$isolateScope', '$scope']); - }, - - isolateScope: function(element) { - // Can't use jqLiteData here directly so we stay compatible with jQuery! - return jqLite(element).data('$isolateScope') || jqLite(element).data('$isolateScopeNoTemplate'); - }, - - controller: jqLiteController, - - injector: function(element) { - return jqLiteInheritedData(element, '$injector'); - }, - - removeAttr: function(element,name) { - element.removeAttribute(name); - }, - - hasClass: jqLiteHasClass, - - css: function(element, name, value) { - name = camelCase(name); - - if (isDefined(value)) { - element.style[name] = value; - } else { - var val; - - if (msie <= 8) { - // this is some IE specific weirdness that jQuery 1.6.4 does not sure why - val = element.currentStyle && element.currentStyle[name]; - if (val === '') val = 'auto'; - } - - val = val || element.style[name]; - - if (msie <= 8) { - // jquery weirdness :-/ - val = (val === '') ? undefined : val; - } - - return val; - } - }, - - attr: function(element, name, value){ - var lowercasedName = lowercase(name); - if (BOOLEAN_ATTR[lowercasedName]) { - if (isDefined(value)) { - if (!!value) { - element[name] = true; - element.setAttribute(name, lowercasedName); - } else { - element[name] = false; - element.removeAttribute(lowercasedName); - } - } else { - return (element[name] || - (element.attributes.getNamedItem(name)|| noop).specified) - ? lowercasedName - : undefined; - } - } else if (isDefined(value)) { - element.setAttribute(name, value); - } else if (element.getAttribute) { - // the extra argument "2" is to get the right thing for a.href in IE, see jQuery code - // some elements (e.g. Document) don't have get attribute, so return undefined - var ret = element.getAttribute(name, 2); - // normalize non-existing attributes to undefined (as jQuery) - return ret === null ? undefined : ret; - } - }, - - prop: function(element, name, value) { - if (isDefined(value)) { - element[name] = value; - } else { - return element[name]; - } - }, - - text: (function() { - var NODE_TYPE_TEXT_PROPERTY = []; - if (msie < 9) { - NODE_TYPE_TEXT_PROPERTY[1] = 'innerText'; /** Element **/ - NODE_TYPE_TEXT_PROPERTY[3] = 'nodeValue'; /** Text **/ - } else { - NODE_TYPE_TEXT_PROPERTY[1] = /** Element **/ - NODE_TYPE_TEXT_PROPERTY[3] = 'textContent'; /** Text **/ - } - getText.$dv = ''; - return getText; - - function getText(element, value) { - var textProp = NODE_TYPE_TEXT_PROPERTY[element.nodeType]; - if (isUndefined(value)) { - return textProp ? element[textProp] : ''; - } - element[textProp] = value; - } - })(), - - val: function(element, value) { - if (isUndefined(value)) { - if (nodeName_(element) === 'SELECT' && element.multiple) { - var result = []; - forEach(element.options, function (option) { - if (option.selected) { - result.push(option.value || option.text); - } - }); - return result.length === 0 ? null : result; - } - return element.value; - } - element.value = value; - }, - - html: function(element, value) { - if (isUndefined(value)) { - return element.innerHTML; - } - for (var i = 0, childNodes = element.childNodes; i < childNodes.length; i++) { - jqLiteDealoc(childNodes[i]); - } - element.innerHTML = value; - }, - - empty: jqLiteEmpty -}, function(fn, name){ - /** - * Properties: writes return selection, reads return first value - */ - JQLite.prototype[name] = function(arg1, arg2) { - var i, key; - - // jqLiteHasClass has only two arguments, but is a getter-only fn, so we need to special-case it - // in a way that survives minification. - // jqLiteEmpty takes no arguments but is a setter. - if (fn !== jqLiteEmpty && - (((fn.length == 2 && (fn !== jqLiteHasClass && fn !== jqLiteController)) ? arg1 : arg2) === undefined)) { - if (isObject(arg1)) { - - // we are a write, but the object properties are the key/values - for (i = 0; i < this.length; i++) { - if (fn === jqLiteData) { - // data() takes the whole object in jQuery - fn(this[i], arg1); - } else { - for (key in arg1) { - fn(this[i], key, arg1[key]); - } - } - } - // return self for chaining - return this; - } else { - // we are a read, so read the first child. - var value = fn.$dv; - // Only if we have $dv do we iterate over all, otherwise it is just the first element. - var jj = (value === undefined) ? Math.min(this.length, 1) : this.length; - for (var j = 0; j < jj; j++) { - var nodeValue = fn(this[j], arg1, arg2); - value = value ? value + nodeValue : nodeValue; - } - return value; - } - } else { - // we are a write, so apply to all children - for (i = 0; i < this.length; i++) { - fn(this[i], arg1, arg2); - } - // return self for chaining - return this; - } - }; -}); - -function createEventHandler(element, events) { - var eventHandler = function (event, type) { - if (!event.preventDefault) { - event.preventDefault = function() { - event.returnValue = false; //ie - }; - } - - if (!event.stopPropagation) { - event.stopPropagation = function() { - event.cancelBubble = true; //ie - }; - } - - if (!event.target) { - event.target = event.srcElement || document; - } - - if (isUndefined(event.defaultPrevented)) { - var prevent = event.preventDefault; - event.preventDefault = function() { - event.defaultPrevented = true; - prevent.call(event); - }; - event.defaultPrevented = false; - } - - event.isDefaultPrevented = function() { - return event.defaultPrevented || event.returnValue === false; - }; - - // Copy event handlers in case event handlers array is modified during execution. - var eventHandlersCopy = shallowCopy(events[type || event.type] || []); - - forEach(eventHandlersCopy, function(fn) { - fn.call(element, event); - }); - - // Remove monkey-patched methods (IE), - // as they would cause memory leaks in IE8. - if (msie <= 8) { - // IE7/8 does not allow to delete property on native object - event.preventDefault = null; - event.stopPropagation = null; - event.isDefaultPrevented = null; - } else { - // It shouldn't affect normal browsers (native methods are defined on prototype). - delete event.preventDefault; - delete event.stopPropagation; - delete event.isDefaultPrevented; - } - }; - eventHandler.elem = element; - return eventHandler; -} - -////////////////////////////////////////// -// Functions iterating traversal. -// These functions chain results into a single -// selector. -////////////////////////////////////////// -forEach({ - removeData: jqLiteRemoveData, - - dealoc: jqLiteDealoc, - - on: function onFn(element, type, fn, unsupported){ - if (isDefined(unsupported)) throw jqLiteMinErr('onargs', 'jqLite#on() does not support the `selector` or `eventData` parameters'); - - var events = jqLiteExpandoStore(element, 'events'), - handle = jqLiteExpandoStore(element, 'handle'); - - if (!events) jqLiteExpandoStore(element, 'events', events = {}); - if (!handle) jqLiteExpandoStore(element, 'handle', handle = createEventHandler(element, events)); - - forEach(type.split(' '), function(type){ - var eventFns = events[type]; - - if (!eventFns) { - if (type == 'mouseenter' || type == 'mouseleave') { - var contains = document.body.contains || document.body.compareDocumentPosition ? - function( a, b ) { - // jshint bitwise: false - var adown = a.nodeType === 9 ? a.documentElement : a, - bup = b && b.parentNode; - return a === bup || !!( bup && bup.nodeType === 1 && ( - adown.contains ? - adown.contains( bup ) : - a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 - )); - } : - function( a, b ) { - if ( b ) { - while ( (b = b.parentNode) ) { - if ( b === a ) { - return true; - } - } - } - return false; - }; - - events[type] = []; - - // Refer to jQuery's implementation of mouseenter & mouseleave - // Read about mouseenter and mouseleave: - // http://www.quirksmode.org/js/events_mouse.html#link8 - var eventmap = { mouseleave : "mouseout", mouseenter : "mouseover"}; - - onFn(element, eventmap[type], function(event) { - var target = this, related = event.relatedTarget; - // For mousenter/leave call the handler if related is outside the target. - // NB: No relatedTarget if the mouse left/entered the browser window - if ( !related || (related !== target && !contains(target, related)) ){ - handle(event, type); - } - }); - - } else { - addEventListenerFn(element, type, handle); - events[type] = []; - } - eventFns = events[type]; - } - eventFns.push(fn); - }); - }, - - off: jqLiteOff, - - one: function(element, type, fn) { - element = jqLite(element); - - //add the listener twice so that when it is called - //you can remove the original function and still be - //able to call element.off(ev, fn) normally - element.on(type, function onFn() { - element.off(type, fn); - element.off(type, onFn); - }); - element.on(type, fn); - }, - - replaceWith: function(element, replaceNode) { - var index, parent = element.parentNode; - jqLiteDealoc(element); - forEach(new JQLite(replaceNode), function(node){ - if (index) { - parent.insertBefore(node, index.nextSibling); - } else { - parent.replaceChild(node, element); - } - index = node; - }); - }, - - children: function(element) { - var children = []; - forEach(element.childNodes, function(element){ - if (element.nodeType === 1) - children.push(element); - }); - return children; - }, - - contents: function(element) { - return element.contentDocument || element.childNodes || []; - }, - - append: function(element, node) { - forEach(new JQLite(node), function(child){ - if (element.nodeType === 1 || element.nodeType === 11) { - element.appendChild(child); - } - }); - }, - - prepend: function(element, node) { - if (element.nodeType === 1) { - var index = element.firstChild; - forEach(new JQLite(node), function(child){ - element.insertBefore(child, index); - }); - } - }, - - wrap: function(element, wrapNode) { - wrapNode = jqLite(wrapNode)[0]; - var parent = element.parentNode; - if (parent) { - parent.replaceChild(wrapNode, element); - } - wrapNode.appendChild(element); - }, - - remove: function(element) { - jqLiteDealoc(element); - var parent = element.parentNode; - if (parent) parent.removeChild(element); - }, - - after: function(element, newElement) { - var index = element, parent = element.parentNode; - forEach(new JQLite(newElement), function(node){ - parent.insertBefore(node, index.nextSibling); - index = node; - }); - }, - - addClass: jqLiteAddClass, - removeClass: jqLiteRemoveClass, - - toggleClass: function(element, selector, condition) { - if (selector) { - forEach(selector.split(' '), function(className){ - var classCondition = condition; - if (isUndefined(classCondition)) { - classCondition = !jqLiteHasClass(element, className); - } - (classCondition ? jqLiteAddClass : jqLiteRemoveClass)(element, className); - }); - } - }, - - parent: function(element) { - var parent = element.parentNode; - return parent && parent.nodeType !== 11 ? parent : null; - }, - - next: function(element) { - if (element.nextElementSibling) { - return element.nextElementSibling; - } - - // IE8 doesn't have nextElementSibling - var elm = element.nextSibling; - while (elm != null && elm.nodeType !== 1) { - elm = elm.nextSibling; - } - return elm; - }, - - find: function(element, selector) { - if (element.getElementsByTagName) { - return element.getElementsByTagName(selector); - } else { - return []; - } - }, - - clone: jqLiteClone, - - triggerHandler: function(element, eventName, eventData) { - var eventFns = (jqLiteExpandoStore(element, 'events') || {})[eventName]; - - eventData = eventData || []; - - var event = [{ - preventDefault: noop, - stopPropagation: noop - }]; - - forEach(eventFns, function(fn) { - fn.apply(element, event.concat(eventData)); - }); - } -}, function(fn, name){ - /** - * chaining functions - */ - JQLite.prototype[name] = function(arg1, arg2, arg3) { - var value; - for(var i=0; i < this.length; i++) { - if (isUndefined(value)) { - value = fn(this[i], arg1, arg2, arg3); - if (isDefined(value)) { - // any function which returns a value needs to be wrapped - value = jqLite(value); - } - } else { - jqLiteAddNodes(value, fn(this[i], arg1, arg2, arg3)); - } - } - return isDefined(value) ? value : this; - }; - - // bind legacy bind/unbind to on/off - JQLite.prototype.bind = JQLite.prototype.on; - JQLite.prototype.unbind = JQLite.prototype.off; -}); - -/** - * Computes a hash of an 'obj'. - * Hash of a: - * string is string - * number is number as string - * object is either result of calling $$hashKey function on the object or uniquely generated id, - * that is also assigned to the $$hashKey property of the object. - * - * @param obj - * @returns {string} hash string such that the same input will have the same hash string. - * The resulting string key is in 'type:hashKey' format. - */ -function hashKey(obj) { - var objType = typeof obj, - key; - - if (objType == 'object' && obj !== null) { - if (typeof (key = obj.$$hashKey) == 'function') { - // must invoke on object to keep the right this - key = obj.$$hashKey(); - } else if (key === undefined) { - key = obj.$$hashKey = nextUid(); - } - } else { - key = obj; - } - - return objType + ':' + key; -} - -/** - * HashMap which can use objects as keys - */ -function HashMap(array){ - forEach(array, this.put, this); -} -HashMap.prototype = { - /** - * Store key value pair - * @param key key to store can be any type - * @param value value to store can be any type - */ - put: function(key, value) { - this[hashKey(key)] = value; - }, - - /** - * @param key - * @returns {Object} the value for the key - */ - get: function(key) { - return this[hashKey(key)]; - }, - - /** - * Remove the key/value pair - * @param key - */ - remove: function(key) { - var value = this[key = hashKey(key)]; - delete this[key]; - return value; - } -}; - -/** - * @ngdoc function - * @module ng - * @name angular.injector - * @function - * - * @description - * Creates an injector function that can be used for retrieving services as well as for - * dependency injection (see {@link guide/di dependency injection}). - * - - * @param {Array.} modules A list of module functions or their aliases. See - * {@link angular.module}. The `ng` module must be explicitly added. - * @returns {function()} Injector function. See {@link auto.$injector $injector}. - * - * @example - * Typical usage - * ```js - * // create an injector - * var $injector = angular.injector(['ng']); - * - * // use the injector to kick off your application - * // use the type inference to auto inject arguments, or use implicit injection - * $injector.invoke(function($rootScope, $compile, $document){ - * $compile($document)($rootScope); - * $rootScope.$digest(); - * }); - * ``` - * - * Sometimes you want to get access to the injector of a currently running Angular app - * from outside Angular. Perhaps, you want to inject and compile some markup after the - * application has been bootstrapped. You can do this using extra `injector()` added - * to JQuery/jqLite elements. See {@link angular.element}. - * - * *This is fairly rare but could be the case if a third party library is injecting the - * markup.* - * - * In the following example a new block of HTML containing a `ng-controller` - * directive is added to the end of the document body by JQuery. We then compile and link - * it into the current AngularJS scope. - * - * ```js - * var $div = $('
{{content.label}}
'); - * $(document.body).append($div); - * - * angular.element(document).injector().invoke(function($compile) { - * var scope = angular.element($div).scope(); - * $compile($div)(scope); - * }); - * ``` - */ - - -/** - * @ngdoc module - * @name auto - * @description - * - * Implicit module which gets automatically added to each {@link auto.$injector $injector}. - */ - -var FN_ARGS = /^function\s*[^\(]*\(\s*([^\)]*)\)/m; -var FN_ARG_SPLIT = /,/; -var FN_ARG = /^\s*(_?)(\S+?)\1\s*$/; -var STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg; -var $injectorMinErr = minErr('$injector'); -function annotate(fn) { - var $inject, - fnText, - argDecl, - last; - - if (typeof fn == 'function') { - if (!($inject = fn.$inject)) { - $inject = []; - if (fn.length) { - fnText = fn.toString().replace(STRIP_COMMENTS, ''); - argDecl = fnText.match(FN_ARGS); - forEach(argDecl[1].split(FN_ARG_SPLIT), function(arg){ - arg.replace(FN_ARG, function(all, underscore, name){ - $inject.push(name); - }); - }); - } - fn.$inject = $inject; - } - } else if (isArray(fn)) { - last = fn.length - 1; - assertArgFn(fn[last], 'fn'); - $inject = fn.slice(0, last); - } else { - assertArgFn(fn, 'fn', true); - } - return $inject; -} - -/////////////////////////////////////// - -/** - * @ngdoc service - * @name $injector - * @function - * - * @description - * - * `$injector` is used to retrieve object instances as defined by - * {@link auto.$provide provider}, instantiate types, invoke methods, - * and load modules. - * - * The following always holds true: - * - * ```js - * var $injector = angular.injector(); - * expect($injector.get('$injector')).toBe($injector); - * expect($injector.invoke(function($injector){ - * return $injector; - * }).toBe($injector); - * ``` - * - * # Injection Function Annotation - * - * JavaScript does not have annotations, and annotations are needed for dependency injection. The - * following are all valid ways of annotating function with injection arguments and are equivalent. - * - * ```js - * // inferred (only works if code not minified/obfuscated) - * $injector.invoke(function(serviceA){}); - * - * // annotated - * function explicit(serviceA) {}; - * explicit.$inject = ['serviceA']; - * $injector.invoke(explicit); - * - * // inline - * $injector.invoke(['serviceA', function(serviceA){}]); - * ``` - * - * ## Inference - * - * In JavaScript calling `toString()` on a function returns the function definition. The definition - * can then be parsed and the function arguments can be extracted. *NOTE:* This does not work with - * minification, and obfuscation tools since these tools change the argument names. - * - * ## `$inject` Annotation - * By adding a `$inject` property onto a function the injection parameters can be specified. - * - * ## Inline - * As an array of injection names, where the last item in the array is the function to call. - */ - -/** - * @ngdoc method - * @name $injector#get - * - * @description - * Return an instance of the service. - * - * @param {string} name The name of the instance to retrieve. - * @return {*} The instance. - */ - -/** - * @ngdoc method - * @name $injector#invoke - * - * @description - * Invoke the method and supply the method arguments from the `$injector`. - * - * @param {!Function} fn The function to invoke. Function parameters are injected according to the - * {@link guide/di $inject Annotation} rules. - * @param {Object=} self The `this` for the invoked method. - * @param {Object=} locals Optional object. If preset then any argument names are read from this - * object first, before the `$injector` is consulted. - * @returns {*} the value returned by the invoked `fn` function. - */ - -/** - * @ngdoc method - * @name $injector#has - * - * @description - * Allows the user to query if the particular service exist. - * - * @param {string} Name of the service to query. - * @returns {boolean} returns true if injector has given service. - */ - -/** - * @ngdoc method - * @name $injector#instantiate - * @description - * Create a new instance of JS type. The method takes a constructor function invokes the new - * operator and supplies all of the arguments to the constructor function as specified by the - * constructor annotation. - * - * @param {Function} Type Annotated constructor function. - * @param {Object=} locals Optional object. If preset then any argument names are read from this - * object first, before the `$injector` is consulted. - * @returns {Object} new instance of `Type`. - */ - -/** - * @ngdoc method - * @name $injector#annotate - * - * @description - * Returns an array of service names which the function is requesting for injection. This API is - * used by the injector to determine which services need to be injected into the function when the - * function is invoked. There are three ways in which the function can be annotated with the needed - * dependencies. - * - * # Argument names - * - * The simplest form is to extract the dependencies from the arguments of the function. This is done - * by converting the function into a string using `toString()` method and extracting the argument - * names. - * ```js - * // Given - * function MyController($scope, $route) { - * // ... - * } - * - * // Then - * expect(injector.annotate(MyController)).toEqual(['$scope', '$route']); - * ``` - * - * This method does not work with code minification / obfuscation. For this reason the following - * annotation strategies are supported. - * - * # The `$inject` property - * - * If a function has an `$inject` property and its value is an array of strings, then the strings - * represent names of services to be injected into the function. - * ```js - * // Given - * var MyController = function(obfuscatedScope, obfuscatedRoute) { - * // ... - * } - * // Define function dependencies - * MyController['$inject'] = ['$scope', '$route']; - * - * // Then - * expect(injector.annotate(MyController)).toEqual(['$scope', '$route']); - * ``` - * - * # The array notation - * - * It is often desirable to inline Injected functions and that's when setting the `$inject` property - * is very inconvenient. In these situations using the array notation to specify the dependencies in - * a way that survives minification is a better choice: - * - * ```js - * // We wish to write this (not minification / obfuscation safe) - * injector.invoke(function($compile, $rootScope) { - * // ... - * }); - * - * // We are forced to write break inlining - * var tmpFn = function(obfuscatedCompile, obfuscatedRootScope) { - * // ... - * }; - * tmpFn.$inject = ['$compile', '$rootScope']; - * injector.invoke(tmpFn); - * - * // To better support inline function the inline annotation is supported - * injector.invoke(['$compile', '$rootScope', function(obfCompile, obfRootScope) { - * // ... - * }]); - * - * // Therefore - * expect(injector.annotate( - * ['$compile', '$rootScope', function(obfus_$compile, obfus_$rootScope) {}]) - * ).toEqual(['$compile', '$rootScope']); - * ``` - * - * @param {Function|Array.} fn Function for which dependent service names need to - * be retrieved as described above. - * - * @returns {Array.} The names of the services which the function requires. - */ - - - - -/** - * @ngdoc object - * @name $provide - * - * @description - * - * The {@link auto.$provide $provide} service has a number of methods for registering components - * with the {@link auto.$injector $injector}. Many of these functions are also exposed on - * {@link angular.Module}. - * - * An Angular **service** is a singleton object created by a **service factory**. These **service - * factories** are functions which, in turn, are created by a **service provider**. - * The **service providers** are constructor functions. When instantiated they must contain a - * property called `$get`, which holds the **service factory** function. - * - * When you request a service, the {@link auto.$injector $injector} is responsible for finding the - * correct **service provider**, instantiating it and then calling its `$get` **service factory** - * function to get the instance of the **service**. - * - * Often services have no configuration options and there is no need to add methods to the service - * provider. The provider will be no more than a constructor function with a `$get` property. For - * these cases the {@link auto.$provide $provide} service has additional helper methods to register - * services without specifying a provider. - * - * * {@link auto.$provide#provider provider(provider)} - registers a **service provider** with the - * {@link auto.$injector $injector} - * * {@link auto.$provide#constant constant(obj)} - registers a value/object that can be accessed by - * providers and services. - * * {@link auto.$provide#value value(obj)} - registers a value/object that can only be accessed by - * services, not providers. - * * {@link auto.$provide#factory factory(fn)} - registers a service **factory function**, `fn`, - * that will be wrapped in a **service provider** object, whose `$get` property will contain the - * given factory function. - * * {@link auto.$provide#service service(class)} - registers a **constructor function**, `class` - * that will be wrapped in a **service provider** object, whose `$get` property will instantiate - * a new object using the given constructor function. - * - * See the individual methods for more information and examples. - */ - -/** - * @ngdoc method - * @name $provide#provider - * @description - * - * Register a **provider function** with the {@link auto.$injector $injector}. Provider functions - * are constructor functions, whose instances are responsible for "providing" a factory for a - * service. - * - * Service provider names start with the name of the service they provide followed by `Provider`. - * For example, the {@link ng.$log $log} service has a provider called - * {@link ng.$logProvider $logProvider}. - * - * Service provider objects can have additional methods which allow configuration of the provider - * and its service. Importantly, you can configure what kind of service is created by the `$get` - * method, or how that service will act. For example, the {@link ng.$logProvider $logProvider} has a - * method {@link ng.$logProvider#debugEnabled debugEnabled} - * which lets you specify whether the {@link ng.$log $log} service will log debug messages to the - * console or not. - * - * @param {string} name The name of the instance. NOTE: the provider will be available under `name + - 'Provider'` key. - * @param {(Object|function())} provider If the provider is: - * - * - `Object`: then it should have a `$get` method. The `$get` method will be invoked using - * {@link auto.$injector#invoke $injector.invoke()} when an instance needs to be created. - * - `Constructor`: a new instance of the provider will be created using - * {@link auto.$injector#instantiate $injector.instantiate()}, then treated as `object`. - * - * @returns {Object} registered provider instance - - * @example - * - * The following example shows how to create a simple event tracking service and register it using - * {@link auto.$provide#provider $provide.provider()}. - * - * ```js - * // Define the eventTracker provider - * function EventTrackerProvider() { - * var trackingUrl = '/track'; - * - * // A provider method for configuring where the tracked events should been saved - * this.setTrackingUrl = function(url) { - * trackingUrl = url; - * }; - * - * // The service factory function - * this.$get = ['$http', function($http) { - * var trackedEvents = {}; - * return { - * // Call this to track an event - * event: function(event) { - * var count = trackedEvents[event] || 0; - * count += 1; - * trackedEvents[event] = count; - * return count; - * }, - * // Call this to save the tracked events to the trackingUrl - * save: function() { - * $http.post(trackingUrl, trackedEvents); - * } - * }; - * }]; - * } - * - * describe('eventTracker', function() { - * var postSpy; - * - * beforeEach(module(function($provide) { - * // Register the eventTracker provider - * $provide.provider('eventTracker', EventTrackerProvider); - * })); - * - * beforeEach(module(function(eventTrackerProvider) { - * // Configure eventTracker provider - * eventTrackerProvider.setTrackingUrl('/custom-track'); - * })); - * - * it('tracks events', inject(function(eventTracker) { - * expect(eventTracker.event('login')).toEqual(1); - * expect(eventTracker.event('login')).toEqual(2); - * })); - * - * it('saves to the tracking url', inject(function(eventTracker, $http) { - * postSpy = spyOn($http, 'post'); - * eventTracker.event('login'); - * eventTracker.save(); - * expect(postSpy).toHaveBeenCalled(); - * expect(postSpy.mostRecentCall.args[0]).not.toEqual('/track'); - * expect(postSpy.mostRecentCall.args[0]).toEqual('/custom-track'); - * expect(postSpy.mostRecentCall.args[1]).toEqual({ 'login': 1 }); - * })); - * }); - * ``` - */ - -/** - * @ngdoc method - * @name $provide#factory - * @description - * - * Register a **service factory**, which will be called to return the service instance. - * This is short for registering a service where its provider consists of only a `$get` property, - * which is the given service factory function. - * You should use {@link auto.$provide#factory $provide.factory(getFn)} if you do not need to - * configure your service in a provider. - * - * @param {string} name The name of the instance. - * @param {function()} $getFn The $getFn for the instance creation. Internally this is a short hand - * for `$provide.provider(name, {$get: $getFn})`. - * @returns {Object} registered provider instance - * - * @example - * Here is an example of registering a service - * ```js - * $provide.factory('ping', ['$http', function($http) { - * return function ping() { - * return $http.send('/ping'); - * }; - * }]); - * ``` - * You would then inject and use this service like this: - * ```js - * someModule.controller('Ctrl', ['ping', function(ping) { - * ping(); - * }]); - * ``` - */ - - -/** - * @ngdoc method - * @name $provide#service - * @description - * - * Register a **service constructor**, which will be invoked with `new` to create the service - * instance. - * This is short for registering a service where its provider's `$get` property is the service - * constructor function that will be used to instantiate the service instance. - * - * You should use {@link auto.$provide#service $provide.service(class)} if you define your service - * as a type/class. - * - * @param {string} name The name of the instance. - * @param {Function} constructor A class (constructor function) that will be instantiated. - * @returns {Object} registered provider instance - * - * @example - * Here is an example of registering a service using - * {@link auto.$provide#service $provide.service(class)}. - * ```js - * var Ping = function($http) { - * this.$http = $http; - * }; - * - * Ping.$inject = ['$http']; - * - * Ping.prototype.send = function() { - * return this.$http.get('/ping'); - * }; - * $provide.service('ping', Ping); - * ``` - * You would then inject and use this service like this: - * ```js - * someModule.controller('Ctrl', ['ping', function(ping) { - * ping.send(); - * }]); - * ``` - */ - - -/** - * @ngdoc method - * @name $provide#value - * @description - * - * Register a **value service** with the {@link auto.$injector $injector}, such as a string, a - * number, an array, an object or a function. This is short for registering a service where its - * provider's `$get` property is a factory function that takes no arguments and returns the **value - * service**. - * - * Value services are similar to constant services, except that they cannot be injected into a - * module configuration function (see {@link angular.Module#config}) but they can be overridden by - * an Angular - * {@link auto.$provide#decorator decorator}. - * - * @param {string} name The name of the instance. - * @param {*} value The value. - * @returns {Object} registered provider instance - * - * @example - * Here are some examples of creating value services. - * ```js - * $provide.value('ADMIN_USER', 'admin'); - * - * $provide.value('RoleLookup', { admin: 0, writer: 1, reader: 2 }); - * - * $provide.value('halfOf', function(value) { - * return value / 2; - * }); - * ``` - */ - - -/** - * @ngdoc method - * @name $provide#constant - * @description - * - * Register a **constant service**, such as a string, a number, an array, an object or a function, - * with the {@link auto.$injector $injector}. Unlike {@link auto.$provide#value value} it can be - * injected into a module configuration function (see {@link angular.Module#config}) and it cannot - * be overridden by an Angular {@link auto.$provide#decorator decorator}. - * - * @param {string} name The name of the constant. - * @param {*} value The constant value. - * @returns {Object} registered instance - * - * @example - * Here a some examples of creating constants: - * ```js - * $provide.constant('SHARD_HEIGHT', 306); - * - * $provide.constant('MY_COLOURS', ['red', 'blue', 'grey']); - * - * $provide.constant('double', function(value) { - * return value * 2; - * }); - * ``` - */ - - -/** - * @ngdoc method - * @name $provide#decorator - * @description - * - * Register a **service decorator** with the {@link auto.$injector $injector}. A service decorator - * intercepts the creation of a service, allowing it to override or modify the behaviour of the - * service. The object returned by the decorator may be the original service, or a new service - * object which replaces or wraps and delegates to the original service. - * - * @param {string} name The name of the service to decorate. - * @param {function()} decorator This function will be invoked when the service needs to be - * instantiated and should return the decorated service instance. The function is called using - * the {@link auto.$injector#invoke injector.invoke} method and is therefore fully injectable. - * Local injection arguments: - * - * * `$delegate` - The original service instance, which can be monkey patched, configured, - * decorated or delegated to. - * - * @example - * Here we decorate the {@link ng.$log $log} service to convert warnings to errors by intercepting - * calls to {@link ng.$log#error $log.warn()}. - * ```js - * $provide.decorator('$log', ['$delegate', function($delegate) { - * $delegate.warn = $delegate.error; - * return $delegate; - * }]); - * ``` - */ - - -function createInjector(modulesToLoad) { - var INSTANTIATING = {}, - providerSuffix = 'Provider', - path = [], - loadedModules = new HashMap(), - providerCache = { - $provide: { - provider: supportObject(provider), - factory: supportObject(factory), - service: supportObject(service), - value: supportObject(value), - constant: supportObject(constant), - decorator: decorator - } - }, - providerInjector = (providerCache.$injector = - createInternalInjector(providerCache, function() { - throw $injectorMinErr('unpr', "Unknown provider: {0}", path.join(' <- ')); - })), - instanceCache = {}, - instanceInjector = (instanceCache.$injector = - createInternalInjector(instanceCache, function(servicename) { - var provider = providerInjector.get(servicename + providerSuffix); - return instanceInjector.invoke(provider.$get, provider); - })); - - - forEach(loadModules(modulesToLoad), function(fn) { instanceInjector.invoke(fn || noop); }); - - return instanceInjector; - - //////////////////////////////////// - // $provider - //////////////////////////////////// - - function supportObject(delegate) { - return function(key, value) { - if (isObject(key)) { - forEach(key, reverseParams(delegate)); - } else { - return delegate(key, value); - } - }; - } - - function provider(name, provider_) { - assertNotHasOwnProperty(name, 'service'); - if (isFunction(provider_) || isArray(provider_)) { - provider_ = providerInjector.instantiate(provider_); - } - if (!provider_.$get) { - throw $injectorMinErr('pget', "Provider '{0}' must define $get factory method.", name); - } - return providerCache[name + providerSuffix] = provider_; - } - - function factory(name, factoryFn) { return provider(name, { $get: factoryFn }); } - - function service(name, constructor) { - return factory(name, ['$injector', function($injector) { - return $injector.instantiate(constructor); - }]); - } - - function value(name, val) { return factory(name, valueFn(val)); } - - function constant(name, value) { - assertNotHasOwnProperty(name, 'constant'); - providerCache[name] = value; - instanceCache[name] = value; - } - - function decorator(serviceName, decorFn) { - var origProvider = providerInjector.get(serviceName + providerSuffix), - orig$get = origProvider.$get; - - origProvider.$get = function() { - var origInstance = instanceInjector.invoke(orig$get, origProvider); - return instanceInjector.invoke(decorFn, null, {$delegate: origInstance}); - }; - } - - //////////////////////////////////// - // Module Loading - //////////////////////////////////// - function loadModules(modulesToLoad){ - var runBlocks = [], moduleFn, invokeQueue, i, ii; - forEach(modulesToLoad, function(module) { - if (loadedModules.get(module)) return; - loadedModules.put(module, true); - - try { - if (isString(module)) { - moduleFn = angularModule(module); - runBlocks = runBlocks.concat(loadModules(moduleFn.requires)).concat(moduleFn._runBlocks); - - for(invokeQueue = moduleFn._invokeQueue, i = 0, ii = invokeQueue.length; i < ii; i++) { - var invokeArgs = invokeQueue[i], - provider = providerInjector.get(invokeArgs[0]); - - provider[invokeArgs[1]].apply(provider, invokeArgs[2]); - } - } else if (isFunction(module)) { - runBlocks.push(providerInjector.invoke(module)); - } else if (isArray(module)) { - runBlocks.push(providerInjector.invoke(module)); - } else { - assertArgFn(module, 'module'); - } - } catch (e) { - if (isArray(module)) { - module = module[module.length - 1]; - } - if (e.message && e.stack && e.stack.indexOf(e.message) == -1) { - // Safari & FF's stack traces don't contain error.message content - // unlike those of Chrome and IE - // So if stack doesn't contain message, we create a new string that contains both. - // Since error.stack is read-only in Safari, I'm overriding e and not e.stack here. - /* jshint -W022 */ - e = e.message + '\n' + e.stack; - } - throw $injectorMinErr('modulerr', "Failed to instantiate module {0} due to:\n{1}", - module, e.stack || e.message || e); - } - }); - return runBlocks; - } - - //////////////////////////////////// - // internal Injector - //////////////////////////////////// - - function createInternalInjector(cache, factory) { - - function getService(serviceName) { - if (cache.hasOwnProperty(serviceName)) { - if (cache[serviceName] === INSTANTIATING) { - throw $injectorMinErr('cdep', 'Circular dependency found: {0}', path.join(' <- ')); - } - return cache[serviceName]; - } else { - try { - path.unshift(serviceName); - cache[serviceName] = INSTANTIATING; - return cache[serviceName] = factory(serviceName); - } catch (err) { - if (cache[serviceName] === INSTANTIATING) { - delete cache[serviceName]; - } - throw err; - } finally { - path.shift(); - } - } - } - - function invoke(fn, self, locals){ - var args = [], - $inject = annotate(fn), - length, i, - key; - - for(i = 0, length = $inject.length; i < length; i++) { - key = $inject[i]; - if (typeof key !== 'string') { - throw $injectorMinErr('itkn', - 'Incorrect injection token! Expected service name as string, got {0}', key); - } - args.push( - locals && locals.hasOwnProperty(key) - ? locals[key] - : getService(key) - ); - } - if (!fn.$inject) { - // this means that we must be an array. - fn = fn[length]; - } - - // http://jsperf.com/angularjs-invoke-apply-vs-switch - // #5388 - return fn.apply(self, args); - } - - function instantiate(Type, locals) { - var Constructor = function() {}, - instance, returnedValue; - - // Check if Type is annotated and use just the given function at n-1 as parameter - // e.g. someModule.factory('greeter', ['$window', function(renamed$window) {}]); - Constructor.prototype = (isArray(Type) ? Type[Type.length - 1] : Type).prototype; - instance = new Constructor(); - returnedValue = invoke(Type, instance, locals); - - return isObject(returnedValue) || isFunction(returnedValue) ? returnedValue : instance; - } - - return { - invoke: invoke, - instantiate: instantiate, - get: getService, - annotate: annotate, - has: function(name) { - return providerCache.hasOwnProperty(name + providerSuffix) || cache.hasOwnProperty(name); - } - }; - } -} - -/** - * @ngdoc service - * @name $anchorScroll - * @kind function - * @requires $window - * @requires $location - * @requires $rootScope - * - * @description - * When called, it checks current value of `$location.hash()` and scroll to related element, - * according to rules specified in - * [Html5 spec](http://dev.w3.org/html5/spec/Overview.html#the-indicated-part-of-the-document). - * - * It also watches the `$location.hash()` and scrolls whenever it changes to match any anchor. - * This can be disabled by calling `$anchorScrollProvider.disableAutoScrolling()`. - * - * @example - - -
- Go to bottom - You're at the bottom! -
- - - function ScrollCtrl($scope, $location, $anchorScroll) { - $scope.gotoBottom = function (){ - // set the location.hash to the id of - // the element you wish to scroll to. - $location.hash('bottom'); - - // call $anchorScroll() - $anchorScroll(); - }; - } - - - #scrollArea { - height: 350px; - overflow: auto; - } - - #bottom { - display: block; - margin-top: 2000px; - } - - - */ -function $AnchorScrollProvider() { - - var autoScrollingEnabled = true; - - this.disableAutoScrolling = function() { - autoScrollingEnabled = false; - }; - - this.$get = ['$window', '$location', '$rootScope', function($window, $location, $rootScope) { - var document = $window.document; - - // helper function to get first anchor from a NodeList - // can't use filter.filter, as it accepts only instances of Array - // and IE can't convert NodeList to an array using [].slice - // TODO(vojta): use filter if we change it to accept lists as well - function getFirstAnchor(list) { - var result = null; - forEach(list, function(element) { - if (!result && lowercase(element.nodeName) === 'a') result = element; - }); - return result; - } - - function scroll() { - var hash = $location.hash(), elm; - - // empty hash, scroll to the top of the page - if (!hash) $window.scrollTo(0, 0); - - // element with given id - else if ((elm = document.getElementById(hash))) elm.scrollIntoView(); - - // first anchor with given name :-D - else if ((elm = getFirstAnchor(document.getElementsByName(hash)))) elm.scrollIntoView(); - - // no element and hash == 'top', scroll to the top of the page - else if (hash === 'top') $window.scrollTo(0, 0); - } - - // does not scroll when user clicks on anchor link that is currently on - // (no url change, no $location.hash() change), browser native does scroll - if (autoScrollingEnabled) { - $rootScope.$watch(function autoScrollWatch() {return $location.hash();}, - function autoScrollWatchAction() { - $rootScope.$evalAsync(scroll); - }); - } - - return scroll; - }]; -} - -var $animateMinErr = minErr('$animate'); - -/** - * @ngdoc provider - * @name $animateProvider - * - * @description - * Default implementation of $animate that doesn't perform any animations, instead just - * synchronously performs DOM - * updates and calls done() callbacks. - * - * In order to enable animations the ngAnimate module has to be loaded. - * - * To see the functional implementation check out src/ngAnimate/animate.js - */ -var $AnimateProvider = ['$provide', function($provide) { - - - this.$$selectors = {}; - - - /** - * @ngdoc method - * @name $animateProvider#register - * - * @description - * Registers a new injectable animation factory function. The factory function produces the - * animation object which contains callback functions for each event that is expected to be - * animated. - * - * * `eventFn`: `function(Element, doneFunction)` The element to animate, the `doneFunction` - * must be called once the element animation is complete. If a function is returned then the - * animation service will use this function to cancel the animation whenever a cancel event is - * triggered. - * - * - * ```js - * return { - * eventFn : function(element, done) { - * //code to run the animation - * //once complete, then run done() - * return function cancellationFunction() { - * //code to cancel the animation - * } - * } - * } - * ``` - * - * @param {string} name The name of the animation. - * @param {Function} factory The factory function that will be executed to return the animation - * object. - */ - this.register = function(name, factory) { - var key = name + '-animation'; - if (name && name.charAt(0) != '.') throw $animateMinErr('notcsel', - "Expecting class selector starting with '.' got '{0}'.", name); - this.$$selectors[name.substr(1)] = key; - $provide.factory(key, factory); - }; - - /** - * @ngdoc method - * @name $animateProvider#classNameFilter - * - * @description - * Sets and/or returns the CSS class regular expression that is checked when performing - * an animation. Upon bootstrap the classNameFilter value is not set at all and will - * therefore enable $animate to attempt to perform an animation on any element. - * When setting the classNameFilter value, animations will only be performed on elements - * that successfully match the filter expression. This in turn can boost performance - * for low-powered devices as well as applications containing a lot of structural operations. - * @param {RegExp=} expression The className expression which will be checked against all animations - * @return {RegExp} The current CSS className expression value. If null then there is no expression value - */ - this.classNameFilter = function(expression) { - if(arguments.length === 1) { - this.$$classNameFilter = (expression instanceof RegExp) ? expression : null; - } - return this.$$classNameFilter; - }; - - this.$get = ['$timeout', '$$asyncCallback', function($timeout, $$asyncCallback) { - - function async(fn) { - fn && $$asyncCallback(fn); - } - - /** - * - * @ngdoc service - * @name $animate - * @description The $animate service provides rudimentary DOM manipulation functions to - * insert, remove and move elements within the DOM, as well as adding and removing classes. - * This service is the core service used by the ngAnimate $animator service which provides - * high-level animation hooks for CSS and JavaScript. - * - * $animate is available in the AngularJS core, however, the ngAnimate module must be included - * to enable full out animation support. Otherwise, $animate will only perform simple DOM - * manipulation operations. - * - * To learn more about enabling animation support, click here to visit the {@link ngAnimate - * ngAnimate module page} as well as the {@link ngAnimate.$animate ngAnimate $animate service - * page}. - */ - return { - - /** - * - * @ngdoc method - * @name $animate#enter - * @function - * @description Inserts the element into the DOM either after the `after` element or within - * the `parent` element. Once complete, the done() callback will be fired (if provided). - * @param {DOMElement} element the element which will be inserted into the DOM - * @param {DOMElement} parent the parent element which will append the element as - * a child (if the after element is not present) - * @param {DOMElement} after the sibling element which will append the element - * after itself - * @param {Function=} done callback function that will be called after the element has been - * inserted into the DOM - */ - enter : function(element, parent, after, done) { - if (after) { - after.after(element); - } else { - if (!parent || !parent[0]) { - parent = after.parent(); - } - parent.append(element); - } - async(done); - }, - - /** - * - * @ngdoc method - * @name $animate#leave - * @function - * @description Removes the element from the DOM. Once complete, the done() callback will be - * fired (if provided). - * @param {DOMElement} element the element which will be removed from the DOM - * @param {Function=} done callback function that will be called after the element has been - * removed from the DOM - */ - leave : function(element, done) { - element.remove(); - async(done); - }, - - /** - * - * @ngdoc method - * @name $animate#move - * @function - * @description Moves the position of the provided element within the DOM to be placed - * either after the `after` element or inside of the `parent` element. Once complete, the - * done() callback will be fired (if provided). - * - * @param {DOMElement} element the element which will be moved around within the - * DOM - * @param {DOMElement} parent the parent element where the element will be - * inserted into (if the after element is not present) - * @param {DOMElement} after the sibling element where the element will be - * positioned next to - * @param {Function=} done the callback function (if provided) that will be fired after the - * element has been moved to its new position - */ - move : function(element, parent, after, done) { - // Do not remove element before insert. Removing will cause data associated with the - // element to be dropped. Insert will implicitly do the remove. - this.enter(element, parent, after, done); - }, - - /** - * - * @ngdoc method - * @name $animate#addClass - * @function - * @description Adds the provided className CSS class value to the provided element. Once - * complete, the done() callback will be fired (if provided). - * @param {DOMElement} element the element which will have the className value - * added to it - * @param {string} className the CSS class which will be added to the element - * @param {Function=} done the callback function (if provided) that will be fired after the - * className value has been added to the element - */ - addClass : function(element, className, done) { - className = isString(className) ? - className : - isArray(className) ? className.join(' ') : ''; - forEach(element, function (element) { - jqLiteAddClass(element, className); - }); - async(done); - }, - - /** - * - * @ngdoc method - * @name $animate#removeClass - * @function - * @description Removes the provided className CSS class value from the provided element. - * Once complete, the done() callback will be fired (if provided). - * @param {DOMElement} element the element which will have the className value - * removed from it - * @param {string} className the CSS class which will be removed from the element - * @param {Function=} done the callback function (if provided) that will be fired after the - * className value has been removed from the element - */ - removeClass : function(element, className, done) { - className = isString(className) ? - className : - isArray(className) ? className.join(' ') : ''; - forEach(element, function (element) { - jqLiteRemoveClass(element, className); - }); - async(done); - }, - - /** - * - * @ngdoc method - * @name $animate#setClass - * @function - * @description Adds and/or removes the given CSS classes to and from the element. - * Once complete, the done() callback will be fired (if provided). - * @param {DOMElement} element the element which will it's CSS classes changed - * removed from it - * @param {string} add the CSS classes which will be added to the element - * @param {string} remove the CSS class which will be removed from the element - * @param {Function=} done the callback function (if provided) that will be fired after the - * CSS classes have been set on the element - */ - setClass : function(element, add, remove, done) { - forEach(element, function (element) { - jqLiteAddClass(element, add); - jqLiteRemoveClass(element, remove); - }); - async(done); - }, - - enabled : noop - }; - }]; -}]; - -function $$AsyncCallbackProvider(){ - this.$get = ['$$rAF', '$timeout', function($$rAF, $timeout) { - return $$rAF.supported - ? function(fn) { return $$rAF(fn); } - : function(fn) { - return $timeout(fn, 0, false); - }; - }]; -} - -/** - * ! This is a private undocumented service ! - * - * @name $browser - * @requires $log - * @description - * This object has two goals: - * - * - hide all the global state in the browser caused by the window object - * - abstract away all the browser specific features and inconsistencies - * - * For tests we provide {@link ngMock.$browser mock implementation} of the `$browser` - * service, which can be used for convenient testing of the application without the interaction with - * the real browser apis. - */ -/** - * @param {object} window The global window object. - * @param {object} document jQuery wrapped document. - * @param {function()} XHR XMLHttpRequest constructor. - * @param {object} $log console.log or an object with the same interface. - * @param {object} $sniffer $sniffer service - */ -function Browser(window, document, $log, $sniffer) { - var self = this, - rawDocument = document[0], - location = window.location, - history = window.history, - setTimeout = window.setTimeout, - clearTimeout = window.clearTimeout, - pendingDeferIds = {}; - - self.isMock = false; - - var outstandingRequestCount = 0; - var outstandingRequestCallbacks = []; - - // TODO(vojta): remove this temporary api - self.$$completeOutstandingRequest = completeOutstandingRequest; - self.$$incOutstandingRequestCount = function() { outstandingRequestCount++; }; - - /** - * Executes the `fn` function(supports currying) and decrements the `outstandingRequestCallbacks` - * counter. If the counter reaches 0, all the `outstandingRequestCallbacks` are executed. - */ - function completeOutstandingRequest(fn) { - try { - fn.apply(null, sliceArgs(arguments, 1)); - } finally { - outstandingRequestCount--; - if (outstandingRequestCount === 0) { - while(outstandingRequestCallbacks.length) { - try { - outstandingRequestCallbacks.pop()(); - } catch (e) { - $log.error(e); - } - } - } - } - } - - /** - * @private - * Note: this method is used only by scenario runner - * TODO(vojta): prefix this method with $$ ? - * @param {function()} callback Function that will be called when no outstanding request - */ - self.notifyWhenNoOutstandingRequests = function(callback) { - // force browser to execute all pollFns - this is needed so that cookies and other pollers fire - // at some deterministic time in respect to the test runner's actions. Leaving things up to the - // regular poller would result in flaky tests. - forEach(pollFns, function(pollFn){ pollFn(); }); - - if (outstandingRequestCount === 0) { - callback(); - } else { - outstandingRequestCallbacks.push(callback); - } - }; - - ////////////////////////////////////////////////////////////// - // Poll Watcher API - ////////////////////////////////////////////////////////////// - var pollFns = [], - pollTimeout; - - /** - * @name $browser#addPollFn - * - * @param {function()} fn Poll function to add - * - * @description - * Adds a function to the list of functions that poller periodically executes, - * and starts polling if not started yet. - * - * @returns {function()} the added function - */ - self.addPollFn = function(fn) { - if (isUndefined(pollTimeout)) startPoller(100, setTimeout); - pollFns.push(fn); - return fn; - }; - - /** - * @param {number} interval How often should browser call poll functions (ms) - * @param {function()} setTimeout Reference to a real or fake `setTimeout` function. - * - * @description - * Configures the poller to run in the specified intervals, using the specified - * setTimeout fn and kicks it off. - */ - function startPoller(interval, setTimeout) { - (function check() { - forEach(pollFns, function(pollFn){ pollFn(); }); - pollTimeout = setTimeout(check, interval); - })(); - } - - ////////////////////////////////////////////////////////////// - // URL API - ////////////////////////////////////////////////////////////// - - var lastBrowserUrl = location.href, - baseElement = document.find('base'), - newLocation = null; - - /** - * @name $browser#url - * - * @description - * GETTER: - * Without any argument, this method just returns current value of location.href. - * - * SETTER: - * With at least one argument, this method sets url to new value. - * If html5 history api supported, pushState/replaceState is used, otherwise - * location.href/location.replace is used. - * Returns its own instance to allow chaining - * - * NOTE: this api is intended for use only by the $location service. Please use the - * {@link ng.$location $location service} to change url. - * - * @param {string} url New url (when used as setter) - * @param {boolean=} replace Should new url replace current history record ? - */ - self.url = function(url, replace) { - // Android Browser BFCache causes location, history reference to become stale. - if (location !== window.location) location = window.location; - if (history !== window.history) history = window.history; - - // setter - if (url) { - if (lastBrowserUrl == url) return; - lastBrowserUrl = url; - if ($sniffer.history) { - if (replace) history.replaceState(null, '', url); - else { - history.pushState(null, '', url); - // Crazy Opera Bug: http://my.opera.com/community/forums/topic.dml?id=1185462 - baseElement.attr('href', baseElement.attr('href')); - } - } else { - newLocation = url; - if (replace) { - location.replace(url); - } else { - location.href = url; - } - } - return self; - // getter - } else { - // - newLocation is a workaround for an IE7-9 issue with location.replace and location.href - // methods not updating location.href synchronously. - // - the replacement is a workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=407172 - return newLocation || location.href.replace(/%27/g,"'"); - } - }; - - var urlChangeListeners = [], - urlChangeInit = false; - - function fireUrlChange() { - newLocation = null; - if (lastBrowserUrl == self.url()) return; - - lastBrowserUrl = self.url(); - forEach(urlChangeListeners, function(listener) { - listener(self.url()); - }); - } - - /** - * @name $browser#onUrlChange - * - * @description - * Register callback function that will be called, when url changes. - * - * It's only called when the url is changed from outside of angular: - * - user types different url into address bar - * - user clicks on history (forward/back) button - * - user clicks on a link - * - * It's not called when url is changed by $browser.url() method - * - * The listener gets called with new url as parameter. - * - * NOTE: this api is intended for use only by the $location service. Please use the - * {@link ng.$location $location service} to monitor url changes in angular apps. - * - * @param {function(string)} listener Listener function to be called when url changes. - * @return {function(string)} Returns the registered listener fn - handy if the fn is anonymous. - */ - self.onUrlChange = function(callback) { - // TODO(vojta): refactor to use node's syntax for events - if (!urlChangeInit) { - // We listen on both (hashchange/popstate) when available, as some browsers (e.g. Opera) - // don't fire popstate when user change the address bar and don't fire hashchange when url - // changed by push/replaceState - - // html5 history api - popstate event - if ($sniffer.history) jqLite(window).on('popstate', fireUrlChange); - // hashchange event - if ($sniffer.hashchange) jqLite(window).on('hashchange', fireUrlChange); - // polling - else self.addPollFn(fireUrlChange); - - urlChangeInit = true; - } - - urlChangeListeners.push(callback); - return callback; - }; - - ////////////////////////////////////////////////////////////// - // Misc API - ////////////////////////////////////////////////////////////// - - /** - * @name $browser#baseHref - * - * @description - * Returns current - * (always relative - without domain) - * - * @returns {string} The current base href - */ - self.baseHref = function() { - var href = baseElement.attr('href'); - return href ? href.replace(/^(https?\:)?\/\/[^\/]*/, '') : ''; - }; - - ////////////////////////////////////////////////////////////// - // Cookies API - ////////////////////////////////////////////////////////////// - var lastCookies = {}; - var lastCookieString = ''; - var cookiePath = self.baseHref(); - - /** - * @name $browser#cookies - * - * @param {string=} name Cookie name - * @param {string=} value Cookie value - * - * @description - * The cookies method provides a 'private' low level access to browser cookies. - * It is not meant to be used directly, use the $cookie service instead. - * - * The return values vary depending on the arguments that the method was called with as follows: - * - * - cookies() -> hash of all cookies, this is NOT a copy of the internal state, so do not modify - * it - * - cookies(name, value) -> set name to value, if value is undefined delete the cookie - * - cookies(name) -> the same as (name, undefined) == DELETES (no one calls it right now that - * way) - * - * @returns {Object} Hash of all cookies (if called without any parameter) - */ - self.cookies = function(name, value) { - /* global escape: false, unescape: false */ - var cookieLength, cookieArray, cookie, i, index; - - if (name) { - if (value === undefined) { - rawDocument.cookie = escape(name) + "=;path=" + cookiePath + - ";expires=Thu, 01 Jan 1970 00:00:00 GMT"; - } else { - if (isString(value)) { - cookieLength = (rawDocument.cookie = escape(name) + '=' + escape(value) + - ';path=' + cookiePath).length + 1; - - // per http://www.ietf.org/rfc/rfc2109.txt browser must allow at minimum: - // - 300 cookies - // - 20 cookies per unique domain - // - 4096 bytes per cookie - if (cookieLength > 4096) { - $log.warn("Cookie '"+ name + - "' possibly not set or overflowed because it was too large ("+ - cookieLength + " > 4096 bytes)!"); - } - } - } - } else { - if (rawDocument.cookie !== lastCookieString) { - lastCookieString = rawDocument.cookie; - cookieArray = lastCookieString.split("; "); - lastCookies = {}; - - for (i = 0; i < cookieArray.length; i++) { - cookie = cookieArray[i]; - index = cookie.indexOf('='); - if (index > 0) { //ignore nameless cookies - name = unescape(cookie.substring(0, index)); - // the first value that is seen for a cookie is the most - // specific one. values for the same cookie name that - // follow are for less specific paths. - if (lastCookies[name] === undefined) { - lastCookies[name] = unescape(cookie.substring(index + 1)); - } - } - } - } - return lastCookies; - } - }; - - - /** - * @name $browser#defer - * @param {function()} fn A function, who's execution should be deferred. - * @param {number=} [delay=0] of milliseconds to defer the function execution. - * @returns {*} DeferId that can be used to cancel the task via `$browser.defer.cancel()`. - * - * @description - * Executes a fn asynchronously via `setTimeout(fn, delay)`. - * - * Unlike when calling `setTimeout` directly, in test this function is mocked and instead of using - * `setTimeout` in tests, the fns are queued in an array, which can be programmatically flushed - * via `$browser.defer.flush()`. - * - */ - self.defer = function(fn, delay) { - var timeoutId; - outstandingRequestCount++; - timeoutId = setTimeout(function() { - delete pendingDeferIds[timeoutId]; - completeOutstandingRequest(fn); - }, delay || 0); - pendingDeferIds[timeoutId] = true; - return timeoutId; - }; - - - /** - * @name $browser#defer.cancel - * - * @description - * Cancels a deferred task identified with `deferId`. - * - * @param {*} deferId Token returned by the `$browser.defer` function. - * @returns {boolean} Returns `true` if the task hasn't executed yet and was successfully - * canceled. - */ - self.defer.cancel = function(deferId) { - if (pendingDeferIds[deferId]) { - delete pendingDeferIds[deferId]; - clearTimeout(deferId); - completeOutstandingRequest(noop); - return true; - } - return false; - }; - -} - -function $BrowserProvider(){ - this.$get = ['$window', '$log', '$sniffer', '$document', - function( $window, $log, $sniffer, $document){ - return new Browser($window, $document, $log, $sniffer); - }]; -} - -/** - * @ngdoc service - * @name $cacheFactory - * - * @description - * Factory that constructs {@link $cacheFactory.Cache Cache} objects and gives access to - * them. - * - * ```js - * - * var cache = $cacheFactory('cacheId'); - * expect($cacheFactory.get('cacheId')).toBe(cache); - * expect($cacheFactory.get('noSuchCacheId')).not.toBeDefined(); - * - * cache.put("key", "value"); - * cache.put("another key", "another value"); - * - * // We've specified no options on creation - * expect(cache.info()).toEqual({id: 'cacheId', size: 2}); - * - * ``` - * - * - * @param {string} cacheId Name or id of the newly created cache. - * @param {object=} options Options object that specifies the cache behavior. Properties: - * - * - `{number=}` `capacity` — turns the cache into LRU cache. - * - * @returns {object} Newly created cache object with the following set of methods: - * - * - `{object}` `info()` — Returns id, size, and options of cache. - * - `{{*}}` `put({string} key, {*} value)` — Puts a new key-value pair into the cache and returns - * it. - * - `{{*}}` `get({string} key)` — Returns cached value for `key` or undefined for cache miss. - * - `{void}` `remove({string} key)` — Removes a key-value pair from the cache. - * - `{void}` `removeAll()` — Removes all cached values. - * - `{void}` `destroy()` — Removes references to this cache from $cacheFactory. - * - * @example - - -
- - - - -

Cached Values

-
- - : - -
- -

Cache Info

-
- - : - -
-
- - - angular.module('cacheExampleApp', []). - controller('CacheController', ['$scope', '$cacheFactory', function($scope, $cacheFactory) { - $scope.keys = []; - $scope.cache = $cacheFactory('cacheId'); - $scope.put = function(key, value) { - $scope.cache.put(key, value); - $scope.keys.push(key); - }; - }]); - - - p { - margin: 10px 0 3px; - } - - - */ -function $CacheFactoryProvider() { - - this.$get = function() { - var caches = {}; - - function cacheFactory(cacheId, options) { - if (cacheId in caches) { - throw minErr('$cacheFactory')('iid', "CacheId '{0}' is already taken!", cacheId); - } - - var size = 0, - stats = extend({}, options, {id: cacheId}), - data = {}, - capacity = (options && options.capacity) || Number.MAX_VALUE, - lruHash = {}, - freshEnd = null, - staleEnd = null; - - /** - * @ngdoc type - * @name $cacheFactory.Cache - * - * @description - * A cache object used to store and retrieve data, primarily used by - * {@link $http $http} and the {@link ng.directive:script script} directive to cache - * templates and other data. - * - * ```js - * angular.module('superCache') - * .factory('superCache', ['$cacheFactory', function($cacheFactory) { - * return $cacheFactory('super-cache'); - * }]); - * ``` - * - * Example test: - * - * ```js - * it('should behave like a cache', inject(function(superCache) { - * superCache.put('key', 'value'); - * superCache.put('another key', 'another value'); - * - * expect(superCache.info()).toEqual({ - * id: 'super-cache', - * size: 2 - * }); - * - * superCache.remove('another key'); - * expect(superCache.get('another key')).toBeUndefined(); - * - * superCache.removeAll(); - * expect(superCache.info()).toEqual({ - * id: 'super-cache', - * size: 0 - * }); - * })); - * ``` - */ - return caches[cacheId] = { - - /** - * @ngdoc method - * @name $cacheFactory.Cache#put - * @function - * - * @description - * Inserts a named entry into the {@link $cacheFactory.Cache Cache} object to be - * retrieved later, and incrementing the size of the cache if the key was not already - * present in the cache. If behaving like an LRU cache, it will also remove stale - * entries from the set. - * - * It will not insert undefined values into the cache. - * - * @param {string} key the key under which the cached data is stored. - * @param {*} value the value to store alongside the key. If it is undefined, the key - * will not be stored. - * @returns {*} the value stored. - */ - put: function(key, value) { - if (capacity < Number.MAX_VALUE) { - var lruEntry = lruHash[key] || (lruHash[key] = {key: key}); - - refresh(lruEntry); - } - - if (isUndefined(value)) return; - if (!(key in data)) size++; - data[key] = value; - - if (size > capacity) { - this.remove(staleEnd.key); - } - - return value; - }, - - /** - * @ngdoc method - * @name $cacheFactory.Cache#get - * @function - * - * @description - * Retrieves named data stored in the {@link $cacheFactory.Cache Cache} object. - * - * @param {string} key the key of the data to be retrieved - * @returns {*} the value stored. - */ - get: function(key) { - if (capacity < Number.MAX_VALUE) { - var lruEntry = lruHash[key]; - - if (!lruEntry) return; - - refresh(lruEntry); - } - - return data[key]; - }, - - - /** - * @ngdoc method - * @name $cacheFactory.Cache#remove - * @function - * - * @description - * Removes an entry from the {@link $cacheFactory.Cache Cache} object. - * - * @param {string} key the key of the entry to be removed - */ - remove: function(key) { - if (capacity < Number.MAX_VALUE) { - var lruEntry = lruHash[key]; - - if (!lruEntry) return; - - if (lruEntry == freshEnd) freshEnd = lruEntry.p; - if (lruEntry == staleEnd) staleEnd = lruEntry.n; - link(lruEntry.n,lruEntry.p); - - delete lruHash[key]; - } - - delete data[key]; - size--; - }, - - - /** - * @ngdoc method - * @name $cacheFactory.Cache#removeAll - * @function - * - * @description - * Clears the cache object of any entries. - */ - removeAll: function() { - data = {}; - size = 0; - lruHash = {}; - freshEnd = staleEnd = null; - }, - - - /** - * @ngdoc method - * @name $cacheFactory.Cache#destroy - * @function - * - * @description - * Destroys the {@link $cacheFactory.Cache Cache} object entirely, - * removing it from the {@link $cacheFactory $cacheFactory} set. - */ - destroy: function() { - data = null; - stats = null; - lruHash = null; - delete caches[cacheId]; - }, - - - /** - * @ngdoc method - * @name $cacheFactory.Cache#info - * @function - * - * @description - * Retrieve information regarding a particular {@link $cacheFactory.Cache Cache}. - * - * @returns {object} an object with the following properties: - *
    - *
  • **id**: the id of the cache instance
    • - *
  • **size**: the number of entries kept in the cache instance
    • - *
  • **...**: any additional properties from the options object when creating the - * cache.
    • - *
- */ - info: function() { - return extend({}, stats, {size: size}); - } - }; - - - /** - * makes the `entry` the freshEnd of the LRU linked list - */ - function refresh(entry) { - if (entry != freshEnd) { - if (!staleEnd) { - staleEnd = entry; - } else if (staleEnd == entry) { - staleEnd = entry.n; - } - - link(entry.n, entry.p); - link(entry, freshEnd); - freshEnd = entry; - freshEnd.n = null; - } - } - - - /** - * bidirectionally links two entries of the LRU linked list - */ - function link(nextEntry, prevEntry) { - if (nextEntry != prevEntry) { - if (nextEntry) nextEntry.p = prevEntry; //p stands for previous, 'prev' didn't minify - if (prevEntry) prevEntry.n = nextEntry; //n stands for next, 'next' didn't minify - } - } - } - - - /** - * @ngdoc method - * @name $cacheFactory#info - * - * @description - * Get information about all the of the caches that have been created - * - * @returns {Object} - key-value map of `cacheId` to the result of calling `cache#info` - */ - cacheFactory.info = function() { - var info = {}; - forEach(caches, function(cache, cacheId) { - info[cacheId] = cache.info(); - }); - return info; - }; - - - /** - * @ngdoc method - * @name $cacheFactory#get - * - * @description - * Get access to a cache object by the `cacheId` used when it was created. - * - * @param {string} cacheId Name or id of a cache to access. - * @returns {object} Cache object identified by the cacheId or undefined if no such cache. - */ - cacheFactory.get = function(cacheId) { - return caches[cacheId]; - }; - - - return cacheFactory; - }; -} - -/** - * @ngdoc service - * @name $templateCache - * - * @description - * The first time a template is used, it is loaded in the template cache for quick retrieval. You - * can load templates directly into the cache in a `script` tag, or by consuming the - * `$templateCache` service directly. - * - * Adding via the `script` tag: - * - * ```html - * - * ``` - * - * **Note:** the `script` tag containing the template does not need to be included in the `head` of - * the document, but it must be below the `ng-app` definition. - * - * Adding via the $templateCache service: - * - * ```js - * var myApp = angular.module('myApp', []); - * myApp.run(function($templateCache) { - * $templateCache.put('templateId.html', 'This is the content of the template'); - * }); - * ``` - * - * To retrieve the template later, simply use it in your HTML: - * ```html - *
- * ``` - * - * or get it via Javascript: - * ```js - * $templateCache.get('templateId.html') - * ``` - * - * See {@link ng.$cacheFactory $cacheFactory}. - * - */ -function $TemplateCacheProvider() { - this.$get = ['$cacheFactory', function($cacheFactory) { - return $cacheFactory('templates'); - }]; -} - -/* ! VARIABLE/FUNCTION NAMING CONVENTIONS THAT APPLY TO THIS FILE! - * - * DOM-related variables: - * - * - "node" - DOM Node - * - "element" - DOM Element or Node - * - "$node" or "$element" - jqLite-wrapped node or element - * - * - * Compiler related stuff: - * - * - "linkFn" - linking fn of a single directive - * - "nodeLinkFn" - function that aggregates all linking fns for a particular node - * - "childLinkFn" - function that aggregates all linking fns for child nodes of a particular node - * - "compositeLinkFn" - function that aggregates all linking fns for a compilation root (nodeList) - */ - - -/** - * @ngdoc service - * @name $compile - * @function - * - * @description - * Compiles an HTML string or DOM into a template and produces a template function, which - * can then be used to link {@link ng.$rootScope.Scope `scope`} and the template together. - * - * The compilation is a process of walking the DOM tree and matching DOM elements to - * {@link ng.$compileProvider#directive directives}. - * - *
- * **Note:** This document is an in-depth reference of all directive options. - * For a gentle introduction to directives with examples of common use cases, - * see the {@link guide/directive directive guide}. - *
- * - * ## Comprehensive Directive API - * - * There are many different options for a directive. - * - * The difference resides in the return value of the factory function. - * You can either return a "Directive Definition Object" (see below) that defines the directive properties, - * or just the `postLink` function (all other properties will have the default values). - * - *
- * **Best Practice:** It's recommended to use the "directive definition object" form. - *
- * - * Here's an example directive declared with a Directive Definition Object: - * - * ```js - * var myModule = angular.module(...); - * - * myModule.directive('directiveName', function factory(injectables) { - * var directiveDefinitionObject = { - * priority: 0, - * template: '
', // or // function(tElement, tAttrs) { ... }, - * // or - * // templateUrl: 'directive.html', // or // function(tElement, tAttrs) { ... }, - * replace: false, - * transclude: false, - * restrict: 'A', - * scope: false, - * controller: function($scope, $element, $attrs, $transclude, otherInjectables) { ... }, - * controllerAs: 'stringAlias', - * require: 'siblingDirectiveName', // or // ['^parentDirectiveName', '?optionalDirectiveName', '?^optionalParent'], - * compile: function compile(tElement, tAttrs, transclude) { - * return { - * pre: function preLink(scope, iElement, iAttrs, controller) { ... }, - * post: function postLink(scope, iElement, iAttrs, controller) { ... } - * } - * // or - * // return function postLink( ... ) { ... } - * }, - * // or - * // link: { - * // pre: function preLink(scope, iElement, iAttrs, controller) { ... }, - * // post: function postLink(scope, iElement, iAttrs, controller) { ... } - * // } - * // or - * // link: function postLink( ... ) { ... } - * }; - * return directiveDefinitionObject; - * }); - * ``` - * - *
- * **Note:** Any unspecified options will use the default value. You can see the default values below. - *
- * - * Therefore the above can be simplified as: - * - * ```js - * var myModule = angular.module(...); - * - * myModule.directive('directiveName', function factory(injectables) { - * var directiveDefinitionObject = { - * link: function postLink(scope, iElement, iAttrs) { ... } - * }; - * return directiveDefinitionObject; - * // or - * // return function postLink(scope, iElement, iAttrs) { ... } - * }); - * ``` - * - * - * - * ### Directive Definition Object - * - * The directive definition object provides instructions to the {@link ng.$compile - * compiler}. The attributes are: - * - * #### `priority` - * When there are multiple directives defined on a single DOM element, sometimes it - * is necessary to specify the order in which the directives are applied. The `priority` is used - * to sort the directives before their `compile` functions get called. Priority is defined as a - * number. Directives with greater numerical `priority` are compiled first. Pre-link functions - * are also run in priority order, but post-link functions are run in reverse order. The order - * of directives with the same priority is undefined. The default priority is `0`. - * - * #### `terminal` - * If set to true then the current `priority` will be the last set of directives - * which will execute (any directives at the current priority will still execute - * as the order of execution on same `priority` is undefined). - * - * #### `scope` - * **If set to `true`,** then a new scope will be created for this directive. If multiple directives on the - * same element request a new scope, only one new scope is created. The new scope rule does not - * apply for the root of the template since the root of the template always gets a new scope. - * - * **If set to `{}` (object hash),** then a new "isolate" scope is created. The 'isolate' scope differs from - * normal scope in that it does not prototypically inherit from the parent scope. This is useful - * when creating reusable components, which should not accidentally read or modify data in the - * parent scope. - * - * The 'isolate' scope takes an object hash which defines a set of local scope properties - * derived from the parent scope. These local properties are useful for aliasing values for - * templates. Locals definition is a hash of local scope property to its source: - * - * * `@` or `@attr` - bind a local scope property to the value of DOM attribute. The result is - * always a string since DOM attributes are strings. If no `attr` name is specified then the - * attribute name is assumed to be the same as the local name. - * Given `` and widget definition - * of `scope: { localName:'@myAttr' }`, then widget scope property `localName` will reflect - * the interpolated value of `hello {{name}}`. As the `name` attribute changes so will the - * `localName` property on the widget scope. The `name` is read from the parent scope (not - * component scope). - * - * * `=` or `=attr` - set up bi-directional binding between a local scope property and the - * parent scope property of name defined via the value of the `attr` attribute. If no `attr` - * name is specified then the attribute name is assumed to be the same as the local name. - * Given `` and widget definition of - * `scope: { localModel:'=myAttr' }`, then widget scope property `localModel` will reflect the - * value of `parentModel` on the parent scope. Any changes to `parentModel` will be reflected - * in `localModel` and any changes in `localModel` will reflect in `parentModel`. If the parent - * scope property doesn't exist, it will throw a NON_ASSIGNABLE_MODEL_EXPRESSION exception. You - * can avoid this behavior using `=?` or `=?attr` in order to flag the property as optional. - * - * * `&` or `&attr` - provides a way to execute an expression in the context of the parent scope. - * If no `attr` name is specified then the attribute name is assumed to be the same as the - * local name. Given `` and widget definition of - * `scope: { localFn:'&myAttr' }`, then isolate scope property `localFn` will point to - * a function wrapper for the `count = count + value` expression. Often it's desirable to - * pass data from the isolated scope via an expression and to the parent scope, this can be - * done by passing a map of local variable names and values into the expression wrapper fn. - * For example, if the expression is `increment(amount)` then we can specify the amount value - * by calling the `localFn` as `localFn({amount: 22})`. - * - * - * - * #### `controller` - * Controller constructor function. The controller is instantiated before the - * pre-linking phase and it is shared with other directives (see - * `require` attribute). This allows the directives to communicate with each other and augment - * each other's behavior. The controller is injectable (and supports bracket notation) with the following locals: - * - * * `$scope` - Current scope associated with the element - * * `$element` - Current element - * * `$attrs` - Current attributes object for the element - * * `$transclude` - A transclude linking function pre-bound to the correct transclusion scope. - * The scope can be overridden by an optional first argument. - * `function([scope], cloneLinkingFn)`. - * - * - * #### `require` - * Require another directive and inject its controller as the fourth argument to the linking function. The - * `require` takes a string name (or array of strings) of the directive(s) to pass in. If an array is used, the - * injected argument will be an array in corresponding order. If no such directive can be - * found, or if the directive does not have a controller, then an error is raised. The name can be prefixed with: - * - * * (no prefix) - Locate the required controller on the current element. Throw an error if not found. - * * `?` - Attempt to locate the required controller or pass `null` to the `link` fn if not found. - * * `^` - Locate the required controller by searching the element's parents. Throw an error if not found. - * * `?^` - Attempt to locate the required controller by searching the element's parents or pass `null` to the - * `link` fn if not found. - * - * - * #### `controllerAs` - * Controller alias at the directive scope. An alias for the controller so it - * can be referenced at the directive template. The directive needs to define a scope for this - * configuration to be used. Useful in the case when directive is used as component. - * - * - * #### `restrict` - * String of subset of `EACM` which restricts the directive to a specific directive - * declaration style. If omitted, the default (attributes only) is used. - * - * * `E` - Element name: `` - * * `A` - Attribute (default): `
` - * * `C` - Class: `
` - * * `M` - Comment: `` - * - * - * #### `template` - * replace the current element with the contents of the HTML. The replacement process - * migrates all of the attributes / classes from the old element to the new one. See the - * {@link guide/directive#creating-custom-directives_creating-directives_template-expanding-directive - * Directives Guide} for an example. - * - * You can specify `template` as a string representing the template or as a function which takes - * two arguments `tElement` and `tAttrs` (described in the `compile` function api below) and - * returns a string value representing the template. - * - * - * #### `templateUrl` - * Same as `template` but the template is loaded from the specified URL. Because - * the template loading is asynchronous the compilation/linking is suspended until the template - * is loaded. - * - * You can specify `templateUrl` as a string representing the URL or as a function which takes two - * arguments `tElement` and `tAttrs` (described in the `compile` function api below) and returns - * a string value representing the url. In either case, the template URL is passed through {@link - * api/ng.$sce#getTrustedResourceUrl $sce.getTrustedResourceUrl}. - * - * - * #### `replace` - * specify where the template should be inserted. Defaults to `false`. - * - * * `true` - the template will replace the current element. - * * `false` - the template will replace the contents of the current element. - * - * - * #### `transclude` - * compile the content of the element and make it available to the directive. - * Typically used with {@link ng.directive:ngTransclude - * ngTransclude}. The advantage of transclusion is that the linking function receives a - * transclusion function which is pre-bound to the correct scope. In a typical setup the widget - * creates an `isolate` scope, but the transclusion is not a child, but a sibling of the `isolate` - * scope. This makes it possible for the widget to have private state, and the transclusion to - * be bound to the parent (pre-`isolate`) scope. - * - * * `true` - transclude the content of the directive. - * * `'element'` - transclude the whole element including any directives defined at lower priority. - * - * - * #### `compile` - * - * ```js - * function compile(tElement, tAttrs, transclude) { ... } - * ``` - * - * The compile function deals with transforming the template DOM. Since most directives do not do - * template transformation, it is not used often. Examples that require compile functions are - * directives that transform template DOM, such as {@link - * api/ng.directive:ngRepeat ngRepeat}, or load the contents - * asynchronously, such as {@link ngRoute.directive:ngView ngView}. The - * compile function takes the following arguments. - * - * * `tElement` - template element - The element where the directive has been declared. It is - * safe to do template transformation on the element and child elements only. - * - * * `tAttrs` - template attributes - Normalized list of attributes declared on this element shared - * between all directive compile functions. - * - * * `transclude` - [*DEPRECATED*!] A transclude linking function: `function(scope, cloneLinkingFn)` - * - *
- * **Note:** The template instance and the link instance may be different objects if the template has - * been cloned. For this reason it is **not** safe to do anything other than DOM transformations that - * apply to all cloned DOM nodes within the compile function. Specifically, DOM listener registration - * should be done in a linking function rather than in a compile function. - *
- - *
- * **Note:** The compile function cannot handle directives that recursively use themselves in their - * own templates or compile functions. Compiling these directives results in an infinite loop and a - * stack overflow errors. - * - * This can be avoided by manually using $compile in the postLink function to imperatively compile - * a directive's template instead of relying on automatic template compilation via `template` or - * `templateUrl` declaration or manual compilation inside the compile function. - *
- * - *
- * **Note:** The `transclude` function that is passed to the compile function is deprecated, as it - * e.g. does not know about the right outer scope. Please use the transclude function that is passed - * to the link function instead. - *
- - * A compile function can have a return value which can be either a function or an object. - * - * * returning a (post-link) function - is equivalent to registering the linking function via the - * `link` property of the config object when the compile function is empty. - * - * * returning an object with function(s) registered via `pre` and `post` properties - allows you to - * control when a linking function should be called during the linking phase. See info about - * pre-linking and post-linking functions below. - * - * - * #### `link` - * This property is used only if the `compile` property is not defined. - * - * ```js - * function link(scope, iElement, iAttrs, controller, transcludeFn) { ... } - * ``` - * - * The link function is responsible for registering DOM listeners as well as updating the DOM. It is - * executed after the template has been cloned. This is where most of the directive logic will be - * put. - * - * * `scope` - {@link ng.$rootScope.Scope Scope} - The scope to be used by the - * directive for registering {@link ng.$rootScope.Scope#$watch watches}. - * - * * `iElement` - instance element - The element where the directive is to be used. It is safe to - * manipulate the children of the element only in `postLink` function since the children have - * already been linked. - * - * * `iAttrs` - instance attributes - Normalized list of attributes declared on this element shared - * between all directive linking functions. - * - * * `controller` - a controller instance - A controller instance if at least one directive on the - * element defines a controller. The controller is shared among all the directives, which allows - * the directives to use the controllers as a communication channel. - * - * * `transcludeFn` - A transclude linking function pre-bound to the correct transclusion scope. - * The scope can be overridden by an optional first argument. This is the same as the `$transclude` - * parameter of directive controllers. - * `function([scope], cloneLinkingFn)`. - * - * - * #### Pre-linking function - * - * Executed before the child elements are linked. Not safe to do DOM transformation since the - * compiler linking function will fail to locate the correct elements for linking. - * - * #### Post-linking function - * - * Executed after the child elements are linked. It is safe to do DOM transformation in the post-linking function. - * - * - * ### Attributes - * - * The {@link ng.$compile.directive.Attributes Attributes} object - passed as a parameter in the - * `link()` or `compile()` functions. It has a variety of uses. - * - * accessing *Normalized attribute names:* - * Directives like 'ngBind' can be expressed in many ways: 'ng:bind', `data-ng-bind`, or 'x-ng-bind'. - * the attributes object allows for normalized access to - * the attributes. - * - * * *Directive inter-communication:* All directives share the same instance of the attributes - * object which allows the directives to use the attributes object as inter directive - * communication. - * - * * *Supports interpolation:* Interpolation attributes are assigned to the attribute object - * allowing other directives to read the interpolated value. - * - * * *Observing interpolated attributes:* Use `$observe` to observe the value changes of attributes - * that contain interpolation (e.g. `src="{{bar}}"`). Not only is this very efficient but it's also - * the only way to easily get the actual value because during the linking phase the interpolation - * hasn't been evaluated yet and so the value is at this time set to `undefined`. - * - * ```js - * function linkingFn(scope, elm, attrs, ctrl) { - * // get the attribute value - * console.log(attrs.ngModel); - * - * // change the attribute - * attrs.$set('ngModel', 'new value'); - * - * // observe changes to interpolated attribute - * attrs.$observe('ngModel', function(value) { - * console.log('ngModel has changed value to ' + value); - * }); - * } - * ``` - * - * Below is an example using `$compileProvider`. - * - *
- * **Note**: Typically directives are registered with `module.directive`. The example below is - * to illustrate how `$compile` works. - *
- * - - - -
-
-
-
-
- - - it('should auto compile', function() { - var textarea = $('textarea'); - var output = $('div[compile]'); - // The initial state reads 'Hello Angular'. - expect(output.getText()).toBe('Hello Angular'); - textarea.clear(); - textarea.sendKeys('{{name}}!'); - expect(output.getText()).toBe('Angular!'); - }); - - - - * - * - * @param {string|DOMElement} element Element or HTML string to compile into a template function. - * @param {function(angular.Scope, cloneAttachFn=)} transclude function available to directives. - * @param {number} maxPriority only apply directives lower than given priority (Only effects the - * root element(s), not their children) - * @returns {function(scope, cloneAttachFn=)} a link function which is used to bind template - * (a DOM element/tree) to a scope. Where: - * - * * `scope` - A {@link ng.$rootScope.Scope Scope} to bind to. - * * `cloneAttachFn` - If `cloneAttachFn` is provided, then the link function will clone the - * `template` and call the `cloneAttachFn` function allowing the caller to attach the - * cloned elements to the DOM document at the appropriate place. The `cloneAttachFn` is - * called as:
`cloneAttachFn(clonedElement, scope)` where: - * - * * `clonedElement` - is a clone of the original `element` passed into the compiler. - * * `scope` - is the current scope with which the linking function is working with. - * - * Calling the linking function returns the element of the template. It is either the original - * element passed in, or the clone of the element if the `cloneAttachFn` is provided. - * - * After linking the view is not updated until after a call to $digest which typically is done by - * Angular automatically. - * - * If you need access to the bound view, there are two ways to do it: - * - * - If you are not asking the linking function to clone the template, create the DOM element(s) - * before you send them to the compiler and keep this reference around. - * ```js - * var element = $compile('

{{total}}

')(scope); - * ``` - * - * - if on the other hand, you need the element to be cloned, the view reference from the original - * example would not point to the clone, but rather to the original template that was cloned. In - * this case, you can access the clone via the cloneAttachFn: - * ```js - * var templateElement = angular.element('

{{total}}

'), - * scope = ....; - * - * var clonedElement = $compile(templateElement)(scope, function(clonedElement, scope) { - * //attach the clone to DOM document at the right place - * }); - * - * //now we have reference to the cloned DOM via `clonedElement` - * ``` - * - * - * For information on how the compiler works, see the - * {@link guide/compiler Angular HTML Compiler} section of the Developer Guide. - */ - -var $compileMinErr = minErr('$compile'); - -/** - * @ngdoc provider - * @name $compileProvider - * @function - * - * @description - */ -$CompileProvider.$inject = ['$provide', '$$sanitizeUriProvider']; -function $CompileProvider($provide, $$sanitizeUriProvider) { - var hasDirectives = {}, - Suffix = 'Directive', - COMMENT_DIRECTIVE_REGEXP = /^\s*directive\:\s*([\d\w\-_]+)\s+(.*)$/, - CLASS_DIRECTIVE_REGEXP = /(([\d\w\-_]+)(?:\:([^;]+))?;?)/; - - // Ref: http://developers.whatwg.org/webappapis.html#event-handler-idl-attributes - // The assumption is that future DOM event attribute names will begin with - // 'on' and be composed of only English letters. - var EVENT_HANDLER_ATTR_REGEXP = /^(on[a-z]+|formaction)$/; - - /** - * @ngdoc method - * @name $compileProvider#directive - * @function - * - * @description - * Register a new directive with the compiler. - * - * @param {string|Object} name Name of the directive in camel-case (i.e. ngBind which - * will match as ng-bind), or an object map of directives where the keys are the - * names and the values are the factories. - * @param {Function|Array} directiveFactory An injectable directive factory function. See - * {@link guide/directive} for more info. - * @returns {ng.$compileProvider} Self for chaining. - */ - this.directive = function registerDirective(name, directiveFactory) { - assertNotHasOwnProperty(name, 'directive'); - if (isString(name)) { - assertArg(directiveFactory, 'directiveFactory'); - if (!hasDirectives.hasOwnProperty(name)) { - hasDirectives[name] = []; - $provide.factory(name + Suffix, ['$injector', '$exceptionHandler', - function($injector, $exceptionHandler) { - var directives = []; - forEach(hasDirectives[name], function(directiveFactory, index) { - try { - var directive = $injector.invoke(directiveFactory); - if (isFunction(directive)) { - directive = { compile: valueFn(directive) }; - } else if (!directive.compile && directive.link) { - directive.compile = valueFn(directive.link); - } - directive.priority = directive.priority || 0; - directive.index = index; - directive.name = directive.name || name; - directive.require = directive.require || (directive.controller && directive.name); - directive.restrict = directive.restrict || 'A'; - directives.push(directive); - } catch (e) { - $exceptionHandler(e); - } - }); - return directives; - }]); - } - hasDirectives[name].push(directiveFactory); - } else { - forEach(name, reverseParams(registerDirective)); - } - return this; - }; - - - /** - * @ngdoc method - * @name $compileProvider#aHrefSanitizationWhitelist - * @function - * - * @description - * Retrieves or overrides the default regular expression that is used for whitelisting of safe - * urls during a[href] sanitization. - * - * The sanitization is a security measure aimed at prevent XSS attacks via html links. - * - * Any url about to be assigned to a[href] via data-binding is first normalized and turned into - * an absolute url. Afterwards, the url is matched against the `aHrefSanitizationWhitelist` - * regular expression. If a match is found, the original url is written into the dom. Otherwise, - * the absolute url is prefixed with `'unsafe:'` string and only then is it written into the DOM. - * - * @param {RegExp=} regexp New regexp to whitelist urls with. - * @returns {RegExp|ng.$compileProvider} Current RegExp if called without value or self for - * chaining otherwise. - */ - this.aHrefSanitizationWhitelist = function(regexp) { - if (isDefined(regexp)) { - $$sanitizeUriProvider.aHrefSanitizationWhitelist(regexp); - return this; - } else { - return $$sanitizeUriProvider.aHrefSanitizationWhitelist(); - } - }; - - - /** - * @ngdoc method - * @name $compileProvider#imgSrcSanitizationWhitelist - * @function - * - * @description - * Retrieves or overrides the default regular expression that is used for whitelisting of safe - * urls during img[src] sanitization. - * - * The sanitization is a security measure aimed at prevent XSS attacks via html links. - * - * Any url about to be assigned to img[src] via data-binding is first normalized and turned into - * an absolute url. Afterwards, the url is matched against the `imgSrcSanitizationWhitelist` - * regular expression. If a match is found, the original url is written into the dom. Otherwise, - * the absolute url is prefixed with `'unsafe:'` string and only then is it written into the DOM. - * - * @param {RegExp=} regexp New regexp to whitelist urls with. - * @returns {RegExp|ng.$compileProvider} Current RegExp if called without value or self for - * chaining otherwise. - */ - this.imgSrcSanitizationWhitelist = function(regexp) { - if (isDefined(regexp)) { - $$sanitizeUriProvider.imgSrcSanitizationWhitelist(regexp); - return this; - } else { - return $$sanitizeUriProvider.imgSrcSanitizationWhitelist(); - } - }; - - this.$get = [ - '$injector', '$interpolate', '$exceptionHandler', '$http', '$templateCache', '$parse', - '$controller', '$rootScope', '$document', '$sce', '$animate', '$$sanitizeUri', - function($injector, $interpolate, $exceptionHandler, $http, $templateCache, $parse, - $controller, $rootScope, $document, $sce, $animate, $$sanitizeUri) { - - var Attributes = function(element, attr) { - this.$$element = element; - this.$attr = attr || {}; - }; - - Attributes.prototype = { - $normalize: directiveNormalize, - - - /** - * @ngdoc method - * @name $compile.directive.Attributes#$addClass - * @function - * - * @description - * Adds the CSS class value specified by the classVal parameter to the element. If animations - * are enabled then an animation will be triggered for the class addition. - * - * @param {string} classVal The className value that will be added to the element - */ - $addClass : function(classVal) { - if(classVal && classVal.length > 0) { - $animate.addClass(this.$$element, classVal); - } - }, - - /** - * @ngdoc method - * @name $compile.directive.Attributes#$removeClass - * @function - * - * @description - * Removes the CSS class value specified by the classVal parameter from the element. If - * animations are enabled then an animation will be triggered for the class removal. - * - * @param {string} classVal The className value that will be removed from the element - */ - $removeClass : function(classVal) { - if(classVal && classVal.length > 0) { - $animate.removeClass(this.$$element, classVal); - } - }, - - /** - * @ngdoc method - * @name $compile.directive.Attributes#$updateClass - * @function - * - * @description - * Adds and removes the appropriate CSS class values to the element based on the difference - * between the new and old CSS class values (specified as newClasses and oldClasses). - * - * @param {string} newClasses The current CSS className value - * @param {string} oldClasses The former CSS className value - */ - $updateClass : function(newClasses, oldClasses) { - var toAdd = tokenDifference(newClasses, oldClasses); - var toRemove = tokenDifference(oldClasses, newClasses); - - if(toAdd.length === 0) { - $animate.removeClass(this.$$element, toRemove); - } else if(toRemove.length === 0) { - $animate.addClass(this.$$element, toAdd); - } else { - $animate.setClass(this.$$element, toAdd, toRemove); - } - }, - - /** - * Set a normalized attribute on the element in a way such that all directives - * can share the attribute. This function properly handles boolean attributes. - * @param {string} key Normalized key. (ie ngAttribute) - * @param {string|boolean} value The value to set. If `null` attribute will be deleted. - * @param {boolean=} writeAttr If false, does not write the value to DOM element attribute. - * Defaults to true. - * @param {string=} attrName Optional none normalized name. Defaults to key. - */ - $set: function(key, value, writeAttr, attrName) { - // TODO: decide whether or not to throw an error if "class" - //is set through this function since it may cause $updateClass to - //become unstable. - - var booleanKey = getBooleanAttrName(this.$$element[0], key), - normalizedVal, - nodeName; - - if (booleanKey) { - this.$$element.prop(key, value); - attrName = booleanKey; - } - - this[key] = value; - - // translate normalized key to actual key - if (attrName) { - this.$attr[key] = attrName; - } else { - attrName = this.$attr[key]; - if (!attrName) { - this.$attr[key] = attrName = snake_case(key, '-'); - } - } - - nodeName = nodeName_(this.$$element); - - // sanitize a[href] and img[src] values - if ((nodeName === 'A' && key === 'href') || - (nodeName === 'IMG' && key === 'src')) { - this[key] = value = $$sanitizeUri(value, key === 'src'); - } - - if (writeAttr !== false) { - if (value === null || value === undefined) { - this.$$element.removeAttr(attrName); - } else { - this.$$element.attr(attrName, value); - } - } - - // fire observers - var $$observers = this.$$observers; - $$observers && forEach($$observers[key], function(fn) { - try { - fn(value); - } catch (e) { - $exceptionHandler(e); - } - }); - }, - - - /** - * @ngdoc method - * @name $compile.directive.Attributes#$observe - * @function - * - * @description - * Observes an interpolated attribute. - * - * The observer function will be invoked once during the next `$digest` following - * compilation. The observer is then invoked whenever the interpolated value - * changes. - * - * @param {string} key Normalized key. (ie ngAttribute) . - * @param {function(interpolatedValue)} fn Function that will be called whenever - the interpolated value of the attribute changes. - * See the {@link guide/directive#Attributes Directives} guide for more info. - * @returns {function()} the `fn` parameter. - */ - $observe: function(key, fn) { - var attrs = this, - $$observers = (attrs.$$observers || (attrs.$$observers = {})), - listeners = ($$observers[key] || ($$observers[key] = [])); - - listeners.push(fn); - $rootScope.$evalAsync(function() { - if (!listeners.$$inter) { - // no one registered attribute interpolation function, so lets call it manually - fn(attrs[key]); - } - }); - return fn; - } - }; - - var startSymbol = $interpolate.startSymbol(), - endSymbol = $interpolate.endSymbol(), - denormalizeTemplate = (startSymbol == '{{' || endSymbol == '}}') - ? identity - : function denormalizeTemplate(template) { - return template.replace(/\{\{/g, startSymbol).replace(/}}/g, endSymbol); - }, - NG_ATTR_BINDING = /^ngAttr[A-Z]/; - - - return compile; - - //================================ - - function compile($compileNodes, transcludeFn, maxPriority, ignoreDirective, - previousCompileContext) { - if (!($compileNodes instanceof jqLite)) { - // jquery always rewraps, whereas we need to preserve the original selector so that we can - // modify it. - $compileNodes = jqLite($compileNodes); - } - // We can not compile top level text elements since text nodes can be merged and we will - // not be able to attach scope data to them, so we will wrap them in - forEach($compileNodes, function(node, index){ - if (node.nodeType == 3 /* text node */ && node.nodeValue.match(/\S+/) /* non-empty */ ) { - $compileNodes[index] = node = jqLite(node).wrap('').parent()[0]; - } - }); - var compositeLinkFn = - compileNodes($compileNodes, transcludeFn, $compileNodes, - maxPriority, ignoreDirective, previousCompileContext); - safeAddClass($compileNodes, 'ng-scope'); - return function publicLinkFn(scope, cloneConnectFn, transcludeControllers){ - assertArg(scope, 'scope'); - // important!!: we must call our jqLite.clone() since the jQuery one is trying to be smart - // and sometimes changes the structure of the DOM. - var $linkNode = cloneConnectFn - ? JQLitePrototype.clone.call($compileNodes) // IMPORTANT!!! - : $compileNodes; - - forEach(transcludeControllers, function(instance, name) { - $linkNode.data('$' + name + 'Controller', instance); - }); - - // Attach scope only to non-text nodes. - for(var i = 0, ii = $linkNode.length; i - addDirective(directives, - directiveNormalize(nodeName_(node).toLowerCase()), 'E', maxPriority, ignoreDirective); - - // iterate over the attributes - for (var attr, name, nName, ngAttrName, value, nAttrs = node.attributes, - j = 0, jj = nAttrs && nAttrs.length; j < jj; j++) { - var attrStartName = false; - var attrEndName = false; - - attr = nAttrs[j]; - if (!msie || msie >= 8 || attr.specified) { - name = attr.name; - // support ngAttr attribute binding - ngAttrName = directiveNormalize(name); - if (NG_ATTR_BINDING.test(ngAttrName)) { - name = snake_case(ngAttrName.substr(6), '-'); - } - - var directiveNName = ngAttrName.replace(/(Start|End)$/, ''); - if (ngAttrName === directiveNName + 'Start') { - attrStartName = name; - attrEndName = name.substr(0, name.length - 5) + 'end'; - name = name.substr(0, name.length - 6); - } - - nName = directiveNormalize(name.toLowerCase()); - attrsMap[nName] = name; - attrs[nName] = value = trim(attr.value); - if (getBooleanAttrName(node, nName)) { - attrs[nName] = true; // presence means true - } - addAttrInterpolateDirective(node, directives, value, nName); - addDirective(directives, nName, 'A', maxPriority, ignoreDirective, attrStartName, - attrEndName); - } - } - - // use class as directive - className = node.className; - if (isString(className) && className !== '') { - while (match = CLASS_DIRECTIVE_REGEXP.exec(className)) { - nName = directiveNormalize(match[2]); - if (addDirective(directives, nName, 'C', maxPriority, ignoreDirective)) { - attrs[nName] = trim(match[3]); - } - className = className.substr(match.index + match[0].length); - } - } - break; - case 3: /* Text Node */ - addTextInterpolateDirective(directives, node.nodeValue); - break; - case 8: /* Comment */ - try { - match = COMMENT_DIRECTIVE_REGEXP.exec(node.nodeValue); - if (match) { - nName = directiveNormalize(match[1]); - if (addDirective(directives, nName, 'M', maxPriority, ignoreDirective)) { - attrs[nName] = trim(match[2]); - } - } - } catch (e) { - // turns out that under some circumstances IE9 throws errors when one attempts to read - // comment's node value. - // Just ignore it and continue. (Can't seem to reproduce in test case.) - } - break; - } - - directives.sort(byPriority); - return directives; - } - - /** - * Given a node with an directive-start it collects all of the siblings until it finds - * directive-end. - * @param node - * @param attrStart - * @param attrEnd - * @returns {*} - */ - function groupScan(node, attrStart, attrEnd) { - var nodes = []; - var depth = 0; - if (attrStart && node.hasAttribute && node.hasAttribute(attrStart)) { - var startNode = node; - do { - if (!node) { - throw $compileMinErr('uterdir', - "Unterminated attribute, found '{0}' but no matching '{1}' found.", - attrStart, attrEnd); - } - if (node.nodeType == 1 /** Element **/) { - if (node.hasAttribute(attrStart)) depth++; - if (node.hasAttribute(attrEnd)) depth--; - } - nodes.push(node); - node = node.nextSibling; - } while (depth > 0); - } else { - nodes.push(node); - } - - return jqLite(nodes); - } - - /** - * Wrapper for linking function which converts normal linking function into a grouped - * linking function. - * @param linkFn - * @param attrStart - * @param attrEnd - * @returns {Function} - */ - function groupElementsLinkFnWrapper(linkFn, attrStart, attrEnd) { - return function(scope, element, attrs, controllers, transcludeFn) { - element = groupScan(element[0], attrStart, attrEnd); - return linkFn(scope, element, attrs, controllers, transcludeFn); - }; - } - - /** - * Once the directives have been collected, their compile functions are executed. This method - * is responsible for inlining directive templates as well as terminating the application - * of the directives if the terminal directive has been reached. - * - * @param {Array} directives Array of collected directives to execute their compile function. - * this needs to be pre-sorted by priority order. - * @param {Node} compileNode The raw DOM node to apply the compile functions to - * @param {Object} templateAttrs The shared attribute function - * @param {function(angular.Scope, cloneAttachFn=)} transcludeFn A linking function, where the - * scope argument is auto-generated to the new - * child of the transcluded parent scope. - * @param {JQLite} jqCollection If we are working on the root of the compile tree then this - * argument has the root jqLite array so that we can replace nodes - * on it. - * @param {Object=} originalReplaceDirective An optional directive that will be ignored when - * compiling the transclusion. - * @param {Array.} preLinkFns - * @param {Array.} postLinkFns - * @param {Object} previousCompileContext Context used for previous compilation of the current - * node - * @returns {Function} linkFn - */ - function applyDirectivesToNode(directives, compileNode, templateAttrs, transcludeFn, - jqCollection, originalReplaceDirective, preLinkFns, postLinkFns, - previousCompileContext) { - previousCompileContext = previousCompileContext || {}; - - var terminalPriority = -Number.MAX_VALUE, - newScopeDirective, - controllerDirectives = previousCompileContext.controllerDirectives, - newIsolateScopeDirective = previousCompileContext.newIsolateScopeDirective, - templateDirective = previousCompileContext.templateDirective, - nonTlbTranscludeDirective = previousCompileContext.nonTlbTranscludeDirective, - hasTranscludeDirective = false, - hasElementTranscludeDirective = previousCompileContext.hasElementTranscludeDirective, - $compileNode = templateAttrs.$$element = jqLite(compileNode), - directive, - directiveName, - $template, - replaceDirective = originalReplaceDirective, - childTranscludeFn = transcludeFn, - linkFn, - directiveValue; - - // executes all directives on the current element - for(var i = 0, ii = directives.length; i < ii; i++) { - directive = directives[i]; - var attrStart = directive.$$start; - var attrEnd = directive.$$end; - - // collect multiblock sections - if (attrStart) { - $compileNode = groupScan(compileNode, attrStart, attrEnd); - } - $template = undefined; - - if (terminalPriority > directive.priority) { - break; // prevent further processing of directives - } - - if (directiveValue = directive.scope) { - newScopeDirective = newScopeDirective || directive; - - // skip the check for directives with async templates, we'll check the derived sync - // directive when the template arrives - if (!directive.templateUrl) { - assertNoDuplicate('new/isolated scope', newIsolateScopeDirective, directive, - $compileNode); - if (isObject(directiveValue)) { - newIsolateScopeDirective = directive; - } - } - } - - directiveName = directive.name; - - if (!directive.templateUrl && directive.controller) { - directiveValue = directive.controller; - controllerDirectives = controllerDirectives || {}; - assertNoDuplicate("'" + directiveName + "' controller", - controllerDirectives[directiveName], directive, $compileNode); - controllerDirectives[directiveName] = directive; - } - - if (directiveValue = directive.transclude) { - hasTranscludeDirective = true; - - // Special case ngIf and ngRepeat so that we don't complain about duplicate transclusion. - // This option should only be used by directives that know how to safely handle element transclusion, - // where the transcluded nodes are added or replaced after linking. - if (!directive.$$tlb) { - assertNoDuplicate('transclusion', nonTlbTranscludeDirective, directive, $compileNode); - nonTlbTranscludeDirective = directive; - } - - if (directiveValue == 'element') { - hasElementTranscludeDirective = true; - terminalPriority = directive.priority; - $template = groupScan(compileNode, attrStart, attrEnd); - $compileNode = templateAttrs.$$element = - jqLite(document.createComment(' ' + directiveName + ': ' + - templateAttrs[directiveName] + ' ')); - compileNode = $compileNode[0]; - replaceWith(jqCollection, jqLite(sliceArgs($template)), compileNode); - - childTranscludeFn = compile($template, transcludeFn, terminalPriority, - replaceDirective && replaceDirective.name, { - // Don't pass in: - // - controllerDirectives - otherwise we'll create duplicates controllers - // - newIsolateScopeDirective or templateDirective - combining templates with - // element transclusion doesn't make sense. - // - // We need only nonTlbTranscludeDirective so that we prevent putting transclusion - // on the same element more than once. - nonTlbTranscludeDirective: nonTlbTranscludeDirective - }); - } else { - $template = jqLite(jqLiteClone(compileNode)).contents(); - $compileNode.empty(); // clear contents - childTranscludeFn = compile($template, transcludeFn); - } - } - - if (directive.template) { - assertNoDuplicate('template', templateDirective, directive, $compileNode); - templateDirective = directive; - - directiveValue = (isFunction(directive.template)) - ? directive.template($compileNode, templateAttrs) - : directive.template; - - directiveValue = denormalizeTemplate(directiveValue); - - if (directive.replace) { - replaceDirective = directive; - if (jqLiteIsTextNode(directiveValue)) { - $template = []; - } else { - $template = jqLite(directiveValue); - } - compileNode = $template[0]; - - if ($template.length != 1 || compileNode.nodeType !== 1) { - throw $compileMinErr('tplrt', - "Template for directive '{0}' must have exactly one root element. {1}", - directiveName, ''); - } - - replaceWith(jqCollection, $compileNode, compileNode); - - var newTemplateAttrs = {$attr: {}}; - - // combine directives from the original node and from the template: - // - take the array of directives for this element - // - split it into two parts, those that already applied (processed) and those that weren't (unprocessed) - // - collect directives from the template and sort them by priority - // - combine directives as: processed + template + unprocessed - var templateDirectives = collectDirectives(compileNode, [], newTemplateAttrs); - var unprocessedDirectives = directives.splice(i + 1, directives.length - (i + 1)); - - if (newIsolateScopeDirective) { - markDirectivesAsIsolate(templateDirectives); - } - directives = directives.concat(templateDirectives).concat(unprocessedDirectives); - mergeTemplateAttributes(templateAttrs, newTemplateAttrs); - - ii = directives.length; - } else { - $compileNode.html(directiveValue); - } - } - - if (directive.templateUrl) { - assertNoDuplicate('template', templateDirective, directive, $compileNode); - templateDirective = directive; - - if (directive.replace) { - replaceDirective = directive; - } - - nodeLinkFn = compileTemplateUrl(directives.splice(i, directives.length - i), $compileNode, - templateAttrs, jqCollection, childTranscludeFn, preLinkFns, postLinkFns, { - controllerDirectives: controllerDirectives, - newIsolateScopeDirective: newIsolateScopeDirective, - templateDirective: templateDirective, - nonTlbTranscludeDirective: nonTlbTranscludeDirective - }); - ii = directives.length; - } else if (directive.compile) { - try { - linkFn = directive.compile($compileNode, templateAttrs, childTranscludeFn); - if (isFunction(linkFn)) { - addLinkFns(null, linkFn, attrStart, attrEnd); - } else if (linkFn) { - addLinkFns(linkFn.pre, linkFn.post, attrStart, attrEnd); - } - } catch (e) { - $exceptionHandler(e, startingTag($compileNode)); - } - } - - if (directive.terminal) { - nodeLinkFn.terminal = true; - terminalPriority = Math.max(terminalPriority, directive.priority); - } - - } - - nodeLinkFn.scope = newScopeDirective && newScopeDirective.scope === true; - nodeLinkFn.transclude = hasTranscludeDirective && childTranscludeFn; - previousCompileContext.hasElementTranscludeDirective = hasElementTranscludeDirective; - - // might be normal or delayed nodeLinkFn depending on if templateUrl is present - return nodeLinkFn; - - //////////////////// - - function addLinkFns(pre, post, attrStart, attrEnd) { - if (pre) { - if (attrStart) pre = groupElementsLinkFnWrapper(pre, attrStart, attrEnd); - pre.require = directive.require; - if (newIsolateScopeDirective === directive || directive.$$isolateScope) { - pre = cloneAndAnnotateFn(pre, {isolateScope: true}); - } - preLinkFns.push(pre); - } - if (post) { - if (attrStart) post = groupElementsLinkFnWrapper(post, attrStart, attrEnd); - post.require = directive.require; - if (newIsolateScopeDirective === directive || directive.$$isolateScope) { - post = cloneAndAnnotateFn(post, {isolateScope: true}); - } - postLinkFns.push(post); - } - } - - - function getControllers(require, $element, elementControllers) { - var value, retrievalMethod = 'data', optional = false; - if (isString(require)) { - while((value = require.charAt(0)) == '^' || value == '?') { - require = require.substr(1); - if (value == '^') { - retrievalMethod = 'inheritedData'; - } - optional = optional || value == '?'; - } - value = null; - - if (elementControllers && retrievalMethod === 'data') { - value = elementControllers[require]; - } - value = value || $element[retrievalMethod]('$' + require + 'Controller'); - - if (!value && !optional) { - throw $compileMinErr('ctreq', - "Controller '{0}', required by directive '{1}', can't be found!", - require, directiveName); - } - return value; - } else if (isArray(require)) { - value = []; - forEach(require, function(require) { - value.push(getControllers(require, $element, elementControllers)); - }); - } - return value; - } - - - function nodeLinkFn(childLinkFn, scope, linkNode, $rootElement, boundTranscludeFn) { - var attrs, $element, i, ii, linkFn, controller, isolateScope, elementControllers = {}, transcludeFn; - - if (compileNode === linkNode) { - attrs = templateAttrs; - } else { - attrs = shallowCopy(templateAttrs, new Attributes(jqLite(linkNode), templateAttrs.$attr)); - } - $element = attrs.$$element; - - if (newIsolateScopeDirective) { - var LOCAL_REGEXP = /^\s*([@=&])(\??)\s*(\w*)\s*$/; - var $linkNode = jqLite(linkNode); - - isolateScope = scope.$new(true); - - if (templateDirective && (templateDirective === newIsolateScopeDirective.$$originalDirective)) { - $linkNode.data('$isolateScope', isolateScope) ; - } else { - $linkNode.data('$isolateScopeNoTemplate', isolateScope); - } - - - - safeAddClass($linkNode, 'ng-isolate-scope'); - - forEach(newIsolateScopeDirective.scope, function(definition, scopeName) { - var match = definition.match(LOCAL_REGEXP) || [], - attrName = match[3] || scopeName, - optional = (match[2] == '?'), - mode = match[1], // @, =, or & - lastValue, - parentGet, parentSet, compare; - - isolateScope.$$isolateBindings[scopeName] = mode + attrName; - - switch (mode) { - - case '@': - attrs.$observe(attrName, function(value) { - isolateScope[scopeName] = value; - }); - attrs.$$observers[attrName].$$scope = scope; - if( attrs[attrName] ) { - // If the attribute has been provided then we trigger an interpolation to ensure - // the value is there for use in the link fn - isolateScope[scopeName] = $interpolate(attrs[attrName])(scope); - } - break; - - case '=': - if (optional && !attrs[attrName]) { - return; - } - parentGet = $parse(attrs[attrName]); - if (parentGet.literal) { - compare = equals; - } else { - compare = function(a,b) { return a === b; }; - } - parentSet = parentGet.assign || function() { - // reset the change, or we will throw this exception on every $digest - lastValue = isolateScope[scopeName] = parentGet(scope); - throw $compileMinErr('nonassign', - "Expression '{0}' used with directive '{1}' is non-assignable!", - attrs[attrName], newIsolateScopeDirective.name); - }; - lastValue = isolateScope[scopeName] = parentGet(scope); - isolateScope.$watch(function parentValueWatch() { - var parentValue = parentGet(scope); - if (!compare(parentValue, isolateScope[scopeName])) { - // we are out of sync and need to copy - if (!compare(parentValue, lastValue)) { - // parent changed and it has precedence - isolateScope[scopeName] = parentValue; - } else { - // if the parent can be assigned then do so - parentSet(scope, parentValue = isolateScope[scopeName]); - } - } - return lastValue = parentValue; - }, null, parentGet.literal); - break; - - case '&': - parentGet = $parse(attrs[attrName]); - isolateScope[scopeName] = function(locals) { - return parentGet(scope, locals); - }; - break; - - default: - throw $compileMinErr('iscp', - "Invalid isolate scope definition for directive '{0}'." + - " Definition: {... {1}: '{2}' ...}", - newIsolateScopeDirective.name, scopeName, definition); - } - }); - } - transcludeFn = boundTranscludeFn && controllersBoundTransclude; - if (controllerDirectives) { - forEach(controllerDirectives, function(directive) { - var locals = { - $scope: directive === newIsolateScopeDirective || directive.$$isolateScope ? isolateScope : scope, - $element: $element, - $attrs: attrs, - $transclude: transcludeFn - }, controllerInstance; - - controller = directive.controller; - if (controller == '@') { - controller = attrs[directive.name]; - } - - controllerInstance = $controller(controller, locals); - // For directives with element transclusion the element is a comment, - // but jQuery .data doesn't support attaching data to comment nodes as it's hard to - // clean up (http://bugs.jquery.com/ticket/8335). - // Instead, we save the controllers for the element in a local hash and attach to .data - // later, once we have the actual element. - elementControllers[directive.name] = controllerInstance; - if (!hasElementTranscludeDirective) { - $element.data('$' + directive.name + 'Controller', controllerInstance); - } - - if (directive.controllerAs) { - locals.$scope[directive.controllerAs] = controllerInstance; - } - }); - } - - // PRELINKING - for(i = 0, ii = preLinkFns.length; i < ii; i++) { - try { - linkFn = preLinkFns[i]; - linkFn(linkFn.isolateScope ? isolateScope : scope, $element, attrs, - linkFn.require && getControllers(linkFn.require, $element, elementControllers), transcludeFn); - } catch (e) { - $exceptionHandler(e, startingTag($element)); - } - } - - // RECURSION - // We only pass the isolate scope, if the isolate directive has a template, - // otherwise the child elements do not belong to the isolate directive. - var scopeToChild = scope; - if (newIsolateScopeDirective && (newIsolateScopeDirective.template || newIsolateScopeDirective.templateUrl === null)) { - scopeToChild = isolateScope; - } - childLinkFn && childLinkFn(scopeToChild, linkNode.childNodes, undefined, boundTranscludeFn); - - // POSTLINKING - for(i = postLinkFns.length - 1; i >= 0; i--) { - try { - linkFn = postLinkFns[i]; - linkFn(linkFn.isolateScope ? isolateScope : scope, $element, attrs, - linkFn.require && getControllers(linkFn.require, $element, elementControllers), transcludeFn); - } catch (e) { - $exceptionHandler(e, startingTag($element)); - } - } - - // This is the function that is injected as `$transclude`. - function controllersBoundTransclude(scope, cloneAttachFn) { - var transcludeControllers; - - // no scope passed - if (arguments.length < 2) { - cloneAttachFn = scope; - scope = undefined; - } - - if (hasElementTranscludeDirective) { - transcludeControllers = elementControllers; - } - - return boundTranscludeFn(scope, cloneAttachFn, transcludeControllers); - } - } - } - - function markDirectivesAsIsolate(directives) { - // mark all directives as needing isolate scope. - for (var j = 0, jj = directives.length; j < jj; j++) { - directives[j] = inherit(directives[j], {$$isolateScope: true}); - } - } - - /** - * looks up the directive and decorates it with exception handling and proper parameters. We - * call this the boundDirective. - * - * @param {string} name name of the directive to look up. - * @param {string} location The directive must be found in specific format. - * String containing any of theses characters: - * - * * `E`: element name - * * `A': attribute - * * `C`: class - * * `M`: comment - * @returns {boolean} true if directive was added. - */ - function addDirective(tDirectives, name, location, maxPriority, ignoreDirective, startAttrName, - endAttrName) { - if (name === ignoreDirective) return null; - var match = null; - if (hasDirectives.hasOwnProperty(name)) { - for(var directive, directives = $injector.get(name + Suffix), - i = 0, ii = directives.length; i directive.priority) && - directive.restrict.indexOf(location) != -1) { - if (startAttrName) { - directive = inherit(directive, {$$start: startAttrName, $$end: endAttrName}); - } - tDirectives.push(directive); - match = directive; - } - } catch(e) { $exceptionHandler(e); } - } - } - return match; - } - - - /** - * When the element is replaced with HTML template then the new attributes - * on the template need to be merged with the existing attributes in the DOM. - * The desired effect is to have both of the attributes present. - * - * @param {object} dst destination attributes (original DOM) - * @param {object} src source attributes (from the directive template) - */ - function mergeTemplateAttributes(dst, src) { - var srcAttr = src.$attr, - dstAttr = dst.$attr, - $element = dst.$$element; - - // reapply the old attributes to the new element - forEach(dst, function(value, key) { - if (key.charAt(0) != '$') { - if (src[key]) { - value += (key === 'style' ? ';' : ' ') + src[key]; - } - dst.$set(key, value, true, srcAttr[key]); - } - }); - - // copy the new attributes on the old attrs object - forEach(src, function(value, key) { - if (key == 'class') { - safeAddClass($element, value); - dst['class'] = (dst['class'] ? dst['class'] + ' ' : '') + value; - } else if (key == 'style') { - $element.attr('style', $element.attr('style') + ';' + value); - dst['style'] = (dst['style'] ? dst['style'] + ';' : '') + value; - // `dst` will never contain hasOwnProperty as DOM parser won't let it. - // You will get an "InvalidCharacterError: DOM Exception 5" error if you - // have an attribute like "has-own-property" or "data-has-own-property", etc. - } else if (key.charAt(0) != '$' && !dst.hasOwnProperty(key)) { - dst[key] = value; - dstAttr[key] = srcAttr[key]; - } - }); - } - - - function compileTemplateUrl(directives, $compileNode, tAttrs, - $rootElement, childTranscludeFn, preLinkFns, postLinkFns, previousCompileContext) { - var linkQueue = [], - afterTemplateNodeLinkFn, - afterTemplateChildLinkFn, - beforeTemplateCompileNode = $compileNode[0], - origAsyncDirective = directives.shift(), - // The fact that we have to copy and patch the directive seems wrong! - derivedSyncDirective = extend({}, origAsyncDirective, { - templateUrl: null, transclude: null, replace: null, $$originalDirective: origAsyncDirective - }), - templateUrl = (isFunction(origAsyncDirective.templateUrl)) - ? origAsyncDirective.templateUrl($compileNode, tAttrs) - : origAsyncDirective.templateUrl; - - $compileNode.empty(); - - $http.get($sce.getTrustedResourceUrl(templateUrl), {cache: $templateCache}). - success(function(content) { - var compileNode, tempTemplateAttrs, $template, childBoundTranscludeFn; - - content = denormalizeTemplate(content); - - if (origAsyncDirective.replace) { - if (jqLiteIsTextNode(content)) { - $template = []; - } else { - $template = jqLite(content); - } - compileNode = $template[0]; - - if ($template.length != 1 || compileNode.nodeType !== 1) { - throw $compileMinErr('tplrt', - "Template for directive '{0}' must have exactly one root element. {1}", - origAsyncDirective.name, templateUrl); - } - - tempTemplateAttrs = {$attr: {}}; - replaceWith($rootElement, $compileNode, compileNode); - var templateDirectives = collectDirectives(compileNode, [], tempTemplateAttrs); - - if (isObject(origAsyncDirective.scope)) { - markDirectivesAsIsolate(templateDirectives); - } - directives = templateDirectives.concat(directives); - mergeTemplateAttributes(tAttrs, tempTemplateAttrs); - } else { - compileNode = beforeTemplateCompileNode; - $compileNode.html(content); - } - - directives.unshift(derivedSyncDirective); - - afterTemplateNodeLinkFn = applyDirectivesToNode(directives, compileNode, tAttrs, - childTranscludeFn, $compileNode, origAsyncDirective, preLinkFns, postLinkFns, - previousCompileContext); - forEach($rootElement, function(node, i) { - if (node == compileNode) { - $rootElement[i] = $compileNode[0]; - } - }); - afterTemplateChildLinkFn = compileNodes($compileNode[0].childNodes, childTranscludeFn); - - - while(linkQueue.length) { - var scope = linkQueue.shift(), - beforeTemplateLinkNode = linkQueue.shift(), - linkRootElement = linkQueue.shift(), - boundTranscludeFn = linkQueue.shift(), - linkNode = $compileNode[0]; - - if (beforeTemplateLinkNode !== beforeTemplateCompileNode) { - var oldClasses = beforeTemplateLinkNode.className; - - if (!(previousCompileContext.hasElementTranscludeDirective && - origAsyncDirective.replace)) { - // it was cloned therefore we have to clone as well. - linkNode = jqLiteClone(compileNode); - } - - replaceWith(linkRootElement, jqLite(beforeTemplateLinkNode), linkNode); - - // Copy in CSS classes from original node - safeAddClass(jqLite(linkNode), oldClasses); - } - if (afterTemplateNodeLinkFn.transclude) { - childBoundTranscludeFn = createBoundTranscludeFn(scope, afterTemplateNodeLinkFn.transclude); - } else { - childBoundTranscludeFn = boundTranscludeFn; - } - afterTemplateNodeLinkFn(afterTemplateChildLinkFn, scope, linkNode, $rootElement, - childBoundTranscludeFn); - } - linkQueue = null; - }). - error(function(response, code, headers, config) { - throw $compileMinErr('tpload', 'Failed to load template: {0}', config.url); - }); - - return function delayedNodeLinkFn(ignoreChildLinkFn, scope, node, rootElement, boundTranscludeFn) { - if (linkQueue) { - linkQueue.push(scope); - linkQueue.push(node); - linkQueue.push(rootElement); - linkQueue.push(boundTranscludeFn); - } else { - afterTemplateNodeLinkFn(afterTemplateChildLinkFn, scope, node, rootElement, boundTranscludeFn); - } - }; - } - - - /** - * Sorting function for bound directives. - */ - function byPriority(a, b) { - var diff = b.priority - a.priority; - if (diff !== 0) return diff; - if (a.name !== b.name) return (a.name < b.name) ? -1 : 1; - return a.index - b.index; - } - - - function assertNoDuplicate(what, previousDirective, directive, element) { - if (previousDirective) { - throw $compileMinErr('multidir', 'Multiple directives [{0}, {1}] asking for {2} on: {3}', - previousDirective.name, directive.name, what, startingTag(element)); - } - } - - - function addTextInterpolateDirective(directives, text) { - var interpolateFn = $interpolate(text, true); - if (interpolateFn) { - directives.push({ - priority: 0, - compile: valueFn(function textInterpolateLinkFn(scope, node) { - var parent = node.parent(), - bindings = parent.data('$binding') || []; - bindings.push(interpolateFn); - safeAddClass(parent.data('$binding', bindings), 'ng-binding'); - scope.$watch(interpolateFn, function interpolateFnWatchAction(value) { - node[0].nodeValue = value; - }); - }) - }); - } - } - - - function getTrustedContext(node, attrNormalizedName) { - if (attrNormalizedName == "srcdoc") { - return $sce.HTML; - } - var tag = nodeName_(node); - // maction[xlink:href] can source SVG. It's not limited to . - if (attrNormalizedName == "xlinkHref" || - (tag == "FORM" && attrNormalizedName == "action") || - (tag != "IMG" && (attrNormalizedName == "src" || - attrNormalizedName == "ngSrc"))) { - return $sce.RESOURCE_URL; - } - } - - - function addAttrInterpolateDirective(node, directives, value, name) { - var interpolateFn = $interpolate(value, true); - - // no interpolation found -> ignore - if (!interpolateFn) return; - - - if (name === "multiple" && nodeName_(node) === "SELECT") { - throw $compileMinErr("selmulti", - "Binding to the 'multiple' attribute is not supported. Element: {0}", - startingTag(node)); - } - - directives.push({ - priority: 100, - compile: function() { - return { - pre: function attrInterpolatePreLinkFn(scope, element, attr) { - var $$observers = (attr.$$observers || (attr.$$observers = {})); - - if (EVENT_HANDLER_ATTR_REGEXP.test(name)) { - throw $compileMinErr('nodomevents', - "Interpolations for HTML DOM event attributes are disallowed. Please use the " + - "ng- versions (such as ng-click instead of onclick) instead."); - } - - // we need to interpolate again, in case the attribute value has been updated - // (e.g. by another directive's compile function) - interpolateFn = $interpolate(attr[name], true, getTrustedContext(node, name)); - - // if attribute was updated so that there is no interpolation going on we don't want to - // register any observers - if (!interpolateFn) return; - - // TODO(i): this should likely be attr.$set(name, iterpolateFn(scope) so that we reset the - // actual attr value - attr[name] = interpolateFn(scope); - ($$observers[name] || ($$observers[name] = [])).$$inter = true; - (attr.$$observers && attr.$$observers[name].$$scope || scope). - $watch(interpolateFn, function interpolateFnWatchAction(newValue, oldValue) { - //special case for class attribute addition + removal - //so that class changes can tap into the animation - //hooks provided by the $animate service. Be sure to - //skip animations when the first digest occurs (when - //both the new and the old values are the same) since - //the CSS classes are the non-interpolated values - if(name === 'class' && newValue != oldValue) { - attr.$updateClass(newValue, oldValue); - } else { - attr.$set(name, newValue); - } - }); - } - }; - } - }); - } - - - /** - * This is a special jqLite.replaceWith, which can replace items which - * have no parents, provided that the containing jqLite collection is provided. - * - * @param {JqLite=} $rootElement The root of the compile tree. Used so that we can replace nodes - * in the root of the tree. - * @param {JqLite} elementsToRemove The jqLite element which we are going to replace. We keep - * the shell, but replace its DOM node reference. - * @param {Node} newNode The new DOM node. - */ - function replaceWith($rootElement, elementsToRemove, newNode) { - var firstElementToRemove = elementsToRemove[0], - removeCount = elementsToRemove.length, - parent = firstElementToRemove.parentNode, - i, ii; - - if ($rootElement) { - for(i = 0, ii = $rootElement.length; i < ii; i++) { - if ($rootElement[i] == firstElementToRemove) { - $rootElement[i++] = newNode; - for (var j = i, j2 = j + removeCount - 1, - jj = $rootElement.length; - j < jj; j++, j2++) { - if (j2 < jj) { - $rootElement[j] = $rootElement[j2]; - } else { - delete $rootElement[j]; - } - } - $rootElement.length -= removeCount - 1; - break; - } - } - } - - if (parent) { - parent.replaceChild(newNode, firstElementToRemove); - } - var fragment = document.createDocumentFragment(); - fragment.appendChild(firstElementToRemove); - newNode[jqLite.expando] = firstElementToRemove[jqLite.expando]; - for (var k = 1, kk = elementsToRemove.length; k < kk; k++) { - var element = elementsToRemove[k]; - jqLite(element).remove(); // must do this way to clean up expando - fragment.appendChild(element); - delete elementsToRemove[k]; - } - - elementsToRemove[0] = newNode; - elementsToRemove.length = 1; - } - - - function cloneAndAnnotateFn(fn, annotation) { - return extend(function() { return fn.apply(null, arguments); }, fn, annotation); - } - }]; -} - -var PREFIX_REGEXP = /^(x[\:\-_]|data[\:\-_])/i; -/** - * Converts all accepted directives format into proper directive name. - * All of these will become 'myDirective': - * my:Directive - * my-directive - * x-my-directive - * data-my:directive - * - * Also there is special case for Moz prefix starting with upper case letter. - * @param name Name to normalize - */ -function directiveNormalize(name) { - return camelCase(name.replace(PREFIX_REGEXP, '')); -} - -/** - * @ngdoc type - * @name $compile.directive.Attributes - * - * @description - * A shared object between directive compile / linking functions which contains normalized DOM - * element attributes. The values reflect current binding state `{{ }}`. The normalization is - * needed since all of these are treated as equivalent in Angular: - * - * - */ - -/** - * @ngdoc property - * @name $compile.directive.Attributes#$attr - * @returns {object} A map of DOM element attribute names to the normalized name. This is - * needed to do reverse lookup from normalized name back to actual name. - */ - - -/** - * @ngdoc method - * @name $compile.directive.Attributes#$set - * @function - * - * @description - * Set DOM element attribute value. - * - * - * @param {string} name Normalized element attribute name of the property to modify. The name is - * reverse-translated using the {@link ng.$compile.directive.Attributes#$attr $attr} - * property to the original name. - * @param {string} value Value to set the attribute to. The value can be an interpolated string. - */ - - - -/** - * Closure compiler type information - */ - -function nodesetLinkingFn( - /* angular.Scope */ scope, - /* NodeList */ nodeList, - /* Element */ rootElement, - /* function(Function) */ boundTranscludeFn -){} - -function directiveLinkingFn( - /* nodesetLinkingFn */ nodesetLinkingFn, - /* angular.Scope */ scope, - /* Node */ node, - /* Element */ rootElement, - /* function(Function) */ boundTranscludeFn -){} - -function tokenDifference(str1, str2) { - var values = '', - tokens1 = str1.split(/\s+/), - tokens2 = str2.split(/\s+/); - - outer: - for(var i = 0; i < tokens1.length; i++) { - var token = tokens1[i]; - for(var j = 0; j < tokens2.length; j++) { - if(token == tokens2[j]) continue outer; - } - values += (values.length > 0 ? ' ' : '') + token; - } - return values; -} - -/** - * @ngdoc provider - * @name $controllerProvider - * @description - * The {@link ng.$controller $controller service} is used by Angular to create new - * controllers. - * - * This provider allows controller registration via the - * {@link ng.$controllerProvider#register register} method. - */ -function $ControllerProvider() { - var controllers = {}, - CNTRL_REG = /^(\S+)(\s+as\s+(\w+))?$/; - - - /** - * @ngdoc method - * @name $controllerProvider#register - * @param {string|Object} name Controller name, or an object map of controllers where the keys are - * the names and the values are the constructors. - * @param {Function|Array} constructor Controller constructor fn (optionally decorated with DI - * annotations in the array notation). - */ - this.register = function(name, constructor) { - assertNotHasOwnProperty(name, 'controller'); - if (isObject(name)) { - extend(controllers, name); - } else { - controllers[name] = constructor; - } - }; - - - this.$get = ['$injector', '$window', function($injector, $window) { - - /** - * @ngdoc service - * @name $controller - * @requires $injector - * - * @param {Function|string} constructor If called with a function then it's considered to be the - * controller constructor function. Otherwise it's considered to be a string which is used - * to retrieve the controller constructor using the following steps: - * - * * check if a controller with given name is registered via `$controllerProvider` - * * check if evaluating the string on the current scope returns a constructor - * * check `window[constructor]` on the global `window` object - * - * @param {Object} locals Injection locals for Controller. - * @return {Object} Instance of given controller. - * - * @description - * `$controller` service is responsible for instantiating controllers. - * - * It's just a simple call to {@link auto.$injector $injector}, but extracted into - * a service, so that one can override this service with [BC version](https://gist.github.com/1649788). - */ - return function(expression, locals) { - var instance, match, constructor, identifier; - - if(isString(expression)) { - match = expression.match(CNTRL_REG), - constructor = match[1], - identifier = match[3]; - expression = controllers.hasOwnProperty(constructor) - ? controllers[constructor] - : getter(locals.$scope, constructor, true) || getter($window, constructor, true); - - assertArgFn(expression, constructor, true); - } - - instance = $injector.instantiate(expression, locals); - - if (identifier) { - if (!(locals && typeof locals.$scope == 'object')) { - throw minErr('$controller')('noscp', - "Cannot export controller '{0}' as '{1}'! No $scope object provided via `locals`.", - constructor || expression.name, identifier); - } - - locals.$scope[identifier] = instance; - } - - return instance; - }; - }]; -} - -/** - * @ngdoc service - * @name $document - * @requires $window - * - * @description - * A {@link angular.element jQuery or jqLite} wrapper for the browser's `window.document` object. - * - * @example - - -
-

$document title:

-

window.document title:

-
- - - function MainCtrl($scope, $document) { - $scope.title = $document[0].title; - $scope.windowTitle = angular.element(window.document)[0].title; - } - - - */ -function $DocumentProvider(){ - this.$get = ['$window', function(window){ - return jqLite(window.document); - }]; -} - -/** - * @ngdoc service - * @name $exceptionHandler - * @requires ng.$log - * - * @description - * Any uncaught exception in angular expressions is delegated to this service. - * The default implementation simply delegates to `$log.error` which logs it into - * the browser console. - * - * In unit tests, if `angular-mocks.js` is loaded, this service is overridden by - * {@link ngMock.$exceptionHandler mock $exceptionHandler} which aids in testing. - * - * ## Example: - * - * ```js - * angular.module('exceptionOverride', []).factory('$exceptionHandler', function () { - * return function (exception, cause) { - * exception.message += ' (caused by "' + cause + '")'; - * throw exception; - * }; - * }); - * ``` - * - * This example will override the normal action of `$exceptionHandler`, to make angular - * exceptions fail hard when they happen, instead of just logging to the console. - * - * @param {Error} exception Exception associated with the error. - * @param {string=} cause optional information about the context in which - * the error was thrown. - * - */ -function $ExceptionHandlerProvider() { - this.$get = ['$log', function($log) { - return function(exception, cause) { - $log.error.apply($log, arguments); - }; - }]; -} - -/** - * Parse headers into key value object - * - * @param {string} headers Raw headers as a string - * @returns {Object} Parsed headers as key value object - */ -function parseHeaders(headers) { - var parsed = {}, key, val, i; - - if (!headers) return parsed; - - forEach(headers.split('\n'), function(line) { - i = line.indexOf(':'); - key = lowercase(trim(line.substr(0, i))); - val = trim(line.substr(i + 1)); - - if (key) { - if (parsed[key]) { - parsed[key] += ', ' + val; - } else { - parsed[key] = val; - } - } - }); - - return parsed; -} - - -/** - * Returns a function that provides access to parsed headers. - * - * Headers are lazy parsed when first requested. - * @see parseHeaders - * - * @param {(string|Object)} headers Headers to provide access to. - * @returns {function(string=)} Returns a getter function which if called with: - * - * - if called with single an argument returns a single header value or null - * - if called with no arguments returns an object containing all headers. - */ -function headersGetter(headers) { - var headersObj = isObject(headers) ? headers : undefined; - - return function(name) { - if (!headersObj) headersObj = parseHeaders(headers); - - if (name) { - return headersObj[lowercase(name)] || null; - } - - return headersObj; - }; -} - - -/** - * Chain all given functions - * - * This function is used for both request and response transforming - * - * @param {*} data Data to transform. - * @param {function(string=)} headers Http headers getter fn. - * @param {(Function|Array.)} fns Function or an array of functions. - * @returns {*} Transformed data. - */ -function transformData(data, headers, fns) { - if (isFunction(fns)) - return fns(data, headers); - - forEach(fns, function(fn) { - data = fn(data, headers); - }); - - return data; -} - - -function isSuccess(status) { - return 200 <= status && status < 300; -} - - -function $HttpProvider() { - var JSON_START = /^\s*(\[|\{[^\{])/, - JSON_END = /[\}\]]\s*$/, - PROTECTION_PREFIX = /^\)\]\}',?\n/, - CONTENT_TYPE_APPLICATION_JSON = {'Content-Type': 'application/json;charset=utf-8'}; - - var defaults = this.defaults = { - // transform incoming response data - transformResponse: [function(data) { - if (isString(data)) { - // strip json vulnerability protection prefix - data = data.replace(PROTECTION_PREFIX, ''); - if (JSON_START.test(data) && JSON_END.test(data)) - data = fromJson(data); - } - return data; - }], - - // transform outgoing request data - transformRequest: [function(d) { - return isObject(d) && !isFile(d) && !isBlob(d) ? toJson(d) : d; - }], - - // default headers - headers: { - common: { - 'Accept': 'application/json, text/plain, */*' - }, - post: copy(CONTENT_TYPE_APPLICATION_JSON), - put: copy(CONTENT_TYPE_APPLICATION_JSON), - patch: copy(CONTENT_TYPE_APPLICATION_JSON) - }, - - xsrfCookieName: 'XSRF-TOKEN', - xsrfHeaderName: 'X-XSRF-TOKEN' - }; - - /** - * Are ordered by request, i.e. they are applied in the same order as the - * array, on request, but reverse order, on response. - */ - var interceptorFactories = this.interceptors = []; - - /** - * For historical reasons, response interceptors are ordered by the order in which - * they are applied to the response. (This is the opposite of interceptorFactories) - */ - var responseInterceptorFactories = this.responseInterceptors = []; - - this.$get = ['$httpBackend', '$browser', '$cacheFactory', '$rootScope', '$q', '$injector', - function($httpBackend, $browser, $cacheFactory, $rootScope, $q, $injector) { - - var defaultCache = $cacheFactory('$http'); - - /** - * Interceptors stored in reverse order. Inner interceptors before outer interceptors. - * The reversal is needed so that we can build up the interception chain around the - * server request. - */ - var reversedInterceptors = []; - - forEach(interceptorFactories, function(interceptorFactory) { - reversedInterceptors.unshift(isString(interceptorFactory) - ? $injector.get(interceptorFactory) : $injector.invoke(interceptorFactory)); - }); - - forEach(responseInterceptorFactories, function(interceptorFactory, index) { - var responseFn = isString(interceptorFactory) - ? $injector.get(interceptorFactory) - : $injector.invoke(interceptorFactory); - - /** - * Response interceptors go before "around" interceptors (no real reason, just - * had to pick one.) But they are already reversed, so we can't use unshift, hence - * the splice. - */ - reversedInterceptors.splice(index, 0, { - response: function(response) { - return responseFn($q.when(response)); - }, - responseError: function(response) { - return responseFn($q.reject(response)); - } - }); - }); - - - /** - * @ngdoc service - * @kind function - * @name $http - * @requires ng.$httpBackend - * @requires $cacheFactory - * @requires $rootScope - * @requires $q - * @requires $injector - * - * @description - * The `$http` service is a core Angular service that facilitates communication with the remote - * HTTP servers via the browser's [XMLHttpRequest](https://developer.mozilla.org/en/xmlhttprequest) - * object or via [JSONP](http://en.wikipedia.org/wiki/JSONP). - * - * For unit testing applications that use `$http` service, see - * {@link ngMock.$httpBackend $httpBackend mock}. - * - * For a higher level of abstraction, please check out the {@link ngResource.$resource - * $resource} service. - * - * The $http API is based on the {@link ng.$q deferred/promise APIs} exposed by - * the $q service. While for simple usage patterns this doesn't matter much, for advanced usage - * it is important to familiarize yourself with these APIs and the guarantees they provide. - * - * - * # General usage - * The `$http` service is a function which takes a single argument — a configuration object — - * that is used to generate an HTTP request and returns a {@link ng.$q promise} - * with two $http specific methods: `success` and `error`. - * - * ```js - * $http({method: 'GET', url: '/someUrl'}). - * success(function(data, status, headers, config) { - * // this callback will be called asynchronously - * // when the response is available - * }). - * error(function(data, status, headers, config) { - * // called asynchronously if an error occurs - * // or server returns response with an error status. - * }); - * ``` - * - * Since the returned value of calling the $http function is a `promise`, you can also use - * the `then` method to register callbacks, and these callbacks will receive a single argument – - * an object representing the response. See the API signature and type info below for more - * details. - * - * A response status code between 200 and 299 is considered a success status and - * will result in the success callback being called. Note that if the response is a redirect, - * XMLHttpRequest will transparently follow it, meaning that the error callback will not be - * called for such responses. - * - * # Writing Unit Tests that use $http - * When unit testing (using {@link ngMock ngMock}), it is necessary to call - * {@link ngMock.$httpBackend#flush $httpBackend.flush()} to flush each pending - * request using trained responses. - * - * ``` - * $httpBackend.expectGET(...); - * $http.get(...); - * $httpBackend.flush(); - * ``` - * - * # Shortcut methods - * - * Shortcut methods are also available. All shortcut methods require passing in the URL, and - * request data must be passed in for POST/PUT requests. - * - * ```js - * $http.get('/someUrl').success(successCallback); - * $http.post('/someUrl', data).success(successCallback); - * ``` - * - * Complete list of shortcut methods: - * - * - {@link ng.$http#get $http.get} - * - {@link ng.$http#head $http.head} - * - {@link ng.$http#post $http.post} - * - {@link ng.$http#put $http.put} - * - {@link ng.$http#delete $http.delete} - * - {@link ng.$http#jsonp $http.jsonp} - * - * - * # Setting HTTP Headers - * - * The $http service will automatically add certain HTTP headers to all requests. These defaults - * can be fully configured by accessing the `$httpProvider.defaults.headers` configuration - * object, which currently contains this default configuration: - * - * - `$httpProvider.defaults.headers.common` (headers that are common for all requests): - * - `Accept: application/json, text/plain, * / *` - * - `$httpProvider.defaults.headers.post`: (header defaults for POST requests) - * - `Content-Type: application/json` - * - `$httpProvider.defaults.headers.put` (header defaults for PUT requests) - * - `Content-Type: application/json` - * - * To add or overwrite these defaults, simply add or remove a property from these configuration - * objects. To add headers for an HTTP method other than POST or PUT, simply add a new object - * with the lowercased HTTP method name as the key, e.g. - * `$httpProvider.defaults.headers.get = { 'My-Header' : 'value' }. - * - * The defaults can also be set at runtime via the `$http.defaults` object in the same - * fashion. For example: - * - * ``` - * module.run(function($http) { - * $http.defaults.headers.common.Authorization = 'Basic YmVlcDpib29w' - * }); - * ``` - * - * In addition, you can supply a `headers` property in the config object passed when - * calling `$http(config)`, which overrides the defaults without changing them globally. - * - * - * # Transforming Requests and Responses - * - * Both requests and responses can be transformed using transform functions. By default, Angular - * applies these transformations: - * - * Request transformations: - * - * - If the `data` property of the request configuration object contains an object, serialize it - * into JSON format. - * - * Response transformations: - * - * - If XSRF prefix is detected, strip it (see Security Considerations section below). - * - If JSON response is detected, deserialize it using a JSON parser. - * - * To globally augment or override the default transforms, modify the - * `$httpProvider.defaults.transformRequest` and `$httpProvider.defaults.transformResponse` - * properties. These properties are by default an array of transform functions, which allows you - * to `push` or `unshift` a new transformation function into the transformation chain. You can - * also decide to completely override any default transformations by assigning your - * transformation functions to these properties directly without the array wrapper. These defaults - * are again available on the $http factory at run-time, which may be useful if you have run-time - * services you wish to be involved in your transformations. - * - * Similarly, to locally override the request/response transforms, augment the - * `transformRequest` and/or `transformResponse` properties of the configuration object passed - * into `$http`. - * - * - * # Caching - * - * To enable caching, set the request configuration `cache` property to `true` (to use default - * cache) or to a custom cache object (built with {@link ng.$cacheFactory `$cacheFactory`}). - * When the cache is enabled, `$http` stores the response from the server in the specified - * cache. The next time the same request is made, the response is served from the cache without - * sending a request to the server. - * - * Note that even if the response is served from cache, delivery of the data is asynchronous in - * the same way that real requests are. - * - * If there are multiple GET requests for the same URL that should be cached using the same - * cache, but the cache is not populated yet, only one request to the server will be made and - * the remaining requests will be fulfilled using the response from the first request. - * - * You can change the default cache to a new object (built with - * {@link ng.$cacheFactory `$cacheFactory`}) by updating the - * {@link ng.$http#properties_defaults `$http.defaults.cache`} property. All requests who set - * their `cache` property to `true` will now use this cache object. - * - * If you set the default cache to `false` then only requests that specify their own custom - * cache object will be cached. - * - * # Interceptors - * - * Before you start creating interceptors, be sure to understand the - * {@link ng.$q $q and deferred/promise APIs}. - * - * For purposes of global error handling, authentication, or any kind of synchronous or - * asynchronous pre-processing of request or postprocessing of responses, it is desirable to be - * able to intercept requests before they are handed to the server and - * responses before they are handed over to the application code that - * initiated these requests. The interceptors leverage the {@link ng.$q - * promise APIs} to fulfill this need for both synchronous and asynchronous pre-processing. - * - * The interceptors are service factories that are registered with the `$httpProvider` by - * adding them to the `$httpProvider.interceptors` array. The factory is called and - * injected with dependencies (if specified) and returns the interceptor. - * - * There are two kinds of interceptors (and two kinds of rejection interceptors): - * - * * `request`: interceptors get called with http `config` object. The function is free to - * modify the `config` or create a new one. The function needs to return the `config` - * directly or as a promise. - * * `requestError`: interceptor gets called when a previous interceptor threw an error or - * resolved with a rejection. - * * `response`: interceptors get called with http `response` object. The function is free to - * modify the `response` or create a new one. The function needs to return the `response` - * directly or as a promise. - * * `responseError`: interceptor gets called when a previous interceptor threw an error or - * resolved with a rejection. - * - * - * ```js - * // register the interceptor as a service - * $provide.factory('myHttpInterceptor', function($q, dependency1, dependency2) { - * return { - * // optional method - * 'request': function(config) { - * // do something on success - * return config || $q.when(config); - * }, - * - * // optional method - * 'requestError': function(rejection) { - * // do something on error - * if (canRecover(rejection)) { - * return responseOrNewPromise - * } - * return $q.reject(rejection); - * }, - * - * - * - * // optional method - * 'response': function(response) { - * // do something on success - * return response || $q.when(response); - * }, - * - * // optional method - * 'responseError': function(rejection) { - * // do something on error - * if (canRecover(rejection)) { - * return responseOrNewPromise - * } - * return $q.reject(rejection); - * } - * }; - * }); - * - * $httpProvider.interceptors.push('myHttpInterceptor'); - * - * - * // alternatively, register the interceptor via an anonymous factory - * $httpProvider.interceptors.push(function($q, dependency1, dependency2) { - * return { - * 'request': function(config) { - * // same as above - * }, - * - * 'response': function(response) { - * // same as above - * } - * }; - * }); - * ``` - * - * # Response interceptors (DEPRECATED) - * - * Before you start creating interceptors, be sure to understand the - * {@link ng.$q $q and deferred/promise APIs}. - * - * For purposes of global error handling, authentication or any kind of synchronous or - * asynchronous preprocessing of received responses, it is desirable to be able to intercept - * responses for http requests before they are handed over to the application code that - * initiated these requests. The response interceptors leverage the {@link ng.$q - * promise apis} to fulfil this need for both synchronous and asynchronous preprocessing. - * - * The interceptors are service factories that are registered with the $httpProvider by - * adding them to the `$httpProvider.responseInterceptors` array. The factory is called and - * injected with dependencies (if specified) and returns the interceptor — a function that - * takes a {@link ng.$q promise} and returns the original or a new promise. - * - * ```js - * // register the interceptor as a service - * $provide.factory('myHttpInterceptor', function($q, dependency1, dependency2) { - * return function(promise) { - * return promise.then(function(response) { - * // do something on success - * return response; - * }, function(response) { - * // do something on error - * if (canRecover(response)) { - * return responseOrNewPromise - * } - * return $q.reject(response); - * }); - * } - * }); - * - * $httpProvider.responseInterceptors.push('myHttpInterceptor'); - * - * - * // register the interceptor via an anonymous factory - * $httpProvider.responseInterceptors.push(function($q, dependency1, dependency2) { - * return function(promise) { - * // same as above - * } - * }); - * ``` - * - * - * # Security Considerations - * - * When designing web applications, consider security threats from: - * - * - [JSON vulnerability](http://haacked.com/archive/2008/11/20/anatomy-of-a-subtle-json-vulnerability.aspx) - * - [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) - * - * Both server and the client must cooperate in order to eliminate these threats. Angular comes - * pre-configured with strategies that address these issues, but for this to work backend server - * cooperation is required. - * - * ## JSON Vulnerability Protection - * - * A [JSON vulnerability](http://haacked.com/archive/2008/11/20/anatomy-of-a-subtle-json-vulnerability.aspx) - * allows third party website to turn your JSON resource URL into - * [JSONP](http://en.wikipedia.org/wiki/JSONP) request under some conditions. To - * counter this your server can prefix all JSON requests with following string `")]}',\n"`. - * Angular will automatically strip the prefix before processing it as JSON. - * - * For example if your server needs to return: - * ```js - * ['one','two'] - * ``` - * - * which is vulnerable to attack, your server can return: - * ```js - * )]}', - * ['one','two'] - * ``` - * - * Angular will strip the prefix, before processing the JSON. - * - * - * ## Cross Site Request Forgery (XSRF) Protection - * - * [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) is a technique by which - * an unauthorized site can gain your user's private data. Angular provides a mechanism - * to counter XSRF. When performing XHR requests, the $http service reads a token from a cookie - * (by default, `XSRF-TOKEN`) and sets it as an HTTP header (`X-XSRF-TOKEN`). Since only - * JavaScript that runs on your domain could read the cookie, your server can be assured that - * the XHR came from JavaScript running on your domain. The header will not be set for - * cross-domain requests. - * - * To take advantage of this, your server needs to set a token in a JavaScript readable session - * cookie called `XSRF-TOKEN` on the first HTTP GET request. On subsequent XHR requests the - * server can verify that the cookie matches `X-XSRF-TOKEN` HTTP header, and therefore be sure - * that only JavaScript running on your domain could have sent the request. The token must be - * unique for each user and must be verifiable by the server (to prevent the JavaScript from - * making up its own tokens). We recommend that the token is a digest of your site's - * authentication cookie with a [salt](https://en.wikipedia.org/wiki/Salt_(cryptography)) - * for added security. - * - * The name of the headers can be specified using the xsrfHeaderName and xsrfCookieName - * properties of either $httpProvider.defaults at config-time, $http.defaults at run-time, - * or the per-request config object. - * - * - * @param {object} config Object describing the request to be made and how it should be - * processed. The object has following properties: - * - * - **method** – `{string}` – HTTP method (e.g. 'GET', 'POST', etc) - * - **url** – `{string}` – Absolute or relative URL of the resource that is being requested. - * - **params** – `{Object.}` – Map of strings or objects which will be turned - * to `?key1=value1&key2=value2` after the url. If the value is not a string, it will be - * JSONified. - * - **data** – `{string|Object}` – Data to be sent as the request message data. - * - **headers** – `{Object}` – Map of strings or functions which return strings representing - * HTTP headers to send to the server. If the return value of a function is null, the - * header will not be sent. - * - **xsrfHeaderName** – `{string}` – Name of HTTP header to populate with the XSRF token. - * - **xsrfCookieName** – `{string}` – Name of cookie containing the XSRF token. - * - **transformRequest** – - * `{function(data, headersGetter)|Array.}` – - * transform function or an array of such functions. The transform function takes the http - * request body and headers and returns its transformed (typically serialized) version. - * - **transformResponse** – - * `{function(data, headersGetter)|Array.}` – - * transform function or an array of such functions. The transform function takes the http - * response body and headers and returns its transformed (typically deserialized) version. - * - **cache** – `{boolean|Cache}` – If true, a default $http cache will be used to cache the - * GET request, otherwise if a cache instance built with - * {@link ng.$cacheFactory $cacheFactory}, this cache will be used for - * caching. - * - **timeout** – `{number|Promise}` – timeout in milliseconds, or {@link ng.$q promise} - * that should abort the request when resolved. - * - **withCredentials** - `{boolean}` - whether to to set the `withCredentials` flag on the - * XHR object. See [requests with credentials]https://developer.mozilla.org/en/http_access_control#section_5 - * for more information. - * - **responseType** - `{string}` - see - * [requestType](https://developer.mozilla.org/en-US/docs/DOM/XMLHttpRequest#responseType). - * - * @returns {HttpPromise} Returns a {@link ng.$q promise} object with the - * standard `then` method and two http specific methods: `success` and `error`. The `then` - * method takes two arguments a success and an error callback which will be called with a - * response object. The `success` and `error` methods take a single argument - a function that - * will be called when the request succeeds or fails respectively. The arguments passed into - * these functions are destructured representation of the response object passed into the - * `then` method. The response object has these properties: - * - * - **data** – `{string|Object}` – The response body transformed with the transform - * functions. - * - **status** – `{number}` – HTTP status code of the response. - * - **headers** – `{function([headerName])}` – Header getter function. - * - **config** – `{Object}` – The configuration object that was used to generate the request. - * - **statusText** – `{string}` – HTTP status text of the response. - * - * @property {Array.} pendingRequests Array of config objects for currently pending - * requests. This is primarily meant to be used for debugging purposes. - * - * - * @example - - -
- - -
- - - - 
http status code: {{status}}
- 
http response data: {{data}}
-
- - - function FetchCtrl($scope, $http, $templateCache) { - $scope.method = 'GET'; - $scope.url = 'http-hello.html'; - - $scope.fetch = function() { - $scope.code = null; - $scope.response = null; - - $http({method: $scope.method, url: $scope.url, cache: $templateCache}). - success(function(data, status) { - $scope.status = status; - $scope.data = data; - }). - error(function(data, status) { - $scope.data = data || "Request failed"; - $scope.status = status; - }); - }; - - $scope.updateModel = function(method, url) { - $scope.method = method; - $scope.url = url; - }; - } - - - Hello, $http! - - - var status = element(by.binding('status')); - var data = element(by.binding('data')); - var fetchBtn = element(by.id('fetchbtn')); - var sampleGetBtn = element(by.id('samplegetbtn')); - var sampleJsonpBtn = element(by.id('samplejsonpbtn')); - var invalidJsonpBtn = element(by.id('invalidjsonpbtn')); - - it('should make an xhr GET request', function() { - sampleGetBtn.click(); - fetchBtn.click(); - expect(status.getText()).toMatch('200'); - expect(data.getText()).toMatch(/Hello, \$http!/); - }); - - it('should make a JSONP request to angularjs.org', function() { - sampleJsonpBtn.click(); - fetchBtn.click(); - expect(status.getText()).toMatch('200'); - expect(data.getText()).toMatch(/Super Hero!/); - }); - - it('should make JSONP request to invalid URL and invoke the error handler', - function() { - invalidJsonpBtn.click(); - fetchBtn.click(); - expect(status.getText()).toMatch('0'); - expect(data.getText()).toMatch('Request failed'); - }); - - - */ - function $http(requestConfig) { - var config = { - method: 'get', - transformRequest: defaults.transformRequest, - transformResponse: defaults.transformResponse - }; - var headers = mergeHeaders(requestConfig); - - extend(config, requestConfig); - config.headers = headers; - config.method = uppercase(config.method); - - var xsrfValue = urlIsSameOrigin(config.url) - ? $browser.cookies()[config.xsrfCookieName || defaults.xsrfCookieName] - : undefined; - if (xsrfValue) { - headers[(config.xsrfHeaderName || defaults.xsrfHeaderName)] = xsrfValue; - } - - - var serverRequest = function(config) { - headers = config.headers; - var reqData = transformData(config.data, headersGetter(headers), config.transformRequest); - - // strip content-type if data is undefined - if (isUndefined(config.data)) { - forEach(headers, function(value, header) { - if (lowercase(header) === 'content-type') { - delete headers[header]; - } - }); - } - - if (isUndefined(config.withCredentials) && !isUndefined(defaults.withCredentials)) { - config.withCredentials = defaults.withCredentials; - } - - // send request - return sendReq(config, reqData, headers).then(transformResponse, transformResponse); - }; - - var chain = [serverRequest, undefined]; - var promise = $q.when(config); - - // apply interceptors - forEach(reversedInterceptors, function(interceptor) { - if (interceptor.request || interceptor.requestError) { - chain.unshift(interceptor.request, interceptor.requestError); - } - if (interceptor.response || interceptor.responseError) { - chain.push(interceptor.response, interceptor.responseError); - } - }); - - while(chain.length) { - var thenFn = chain.shift(); - var rejectFn = chain.shift(); - - promise = promise.then(thenFn, rejectFn); - } - - promise.success = function(fn) { - promise.then(function(response) { - fn(response.data, response.status, response.headers, config); - }); - return promise; - }; - - promise.error = function(fn) { - promise.then(null, function(response) { - fn(response.data, response.status, response.headers, config); - }); - return promise; - }; - - return promise; - - function transformResponse(response) { - // make a copy since the response must be cacheable - var resp = extend({}, response, { - data: transformData(response.data, response.headers, config.transformResponse) - }); - return (isSuccess(response.status)) - ? resp - : $q.reject(resp); - } - - function mergeHeaders(config) { - var defHeaders = defaults.headers, - reqHeaders = extend({}, config.headers), - defHeaderName, lowercaseDefHeaderName, reqHeaderName; - - defHeaders = extend({}, defHeaders.common, defHeaders[lowercase(config.method)]); - - // execute if header value is function - execHeaders(defHeaders); - execHeaders(reqHeaders); - - // using for-in instead of forEach to avoid unecessary iteration after header has been found - defaultHeadersIteration: - for (defHeaderName in defHeaders) { - lowercaseDefHeaderName = lowercase(defHeaderName); - - for (reqHeaderName in reqHeaders) { - if (lowercase(reqHeaderName) === lowercaseDefHeaderName) { - continue defaultHeadersIteration; - } - } - - reqHeaders[defHeaderName] = defHeaders[defHeaderName]; - } - - return reqHeaders; - - function execHeaders(headers) { - var headerContent; - - forEach(headers, function(headerFn, header) { - if (isFunction(headerFn)) { - headerContent = headerFn(); - if (headerContent != null) { - headers[header] = headerContent; - } else { - delete headers[header]; - } - } - }); - } - } - } - - $http.pendingRequests = []; - - /** - * @ngdoc method - * @name $http#get - * - * @description - * Shortcut method to perform `GET` request. - * - * @param {string} url Relative or absolute URL specifying the destination of the request - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - - /** - * @ngdoc method - * @name $http#delete - * - * @description - * Shortcut method to perform `DELETE` request. - * - * @param {string} url Relative or absolute URL specifying the destination of the request - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - - /** - * @ngdoc method - * @name $http#head - * - * @description - * Shortcut method to perform `HEAD` request. - * - * @param {string} url Relative or absolute URL specifying the destination of the request - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - - /** - * @ngdoc method - * @name $http#jsonp - * - * @description - * Shortcut method to perform `JSONP` request. - * - * @param {string} url Relative or absolute URL specifying the destination of the request. - * Should contain `JSON_CALLBACK` string. - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - createShortMethods('get', 'delete', 'head', 'jsonp'); - - /** - * @ngdoc method - * @name $http#post - * - * @description - * Shortcut method to perform `POST` request. - * - * @param {string} url Relative or absolute URL specifying the destination of the request - * @param {*} data Request content - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - - /** - * @ngdoc method - * @name $http#put - * - * @description - * Shortcut method to perform `PUT` request. - * - * @param {string} url Relative or absolute URL specifying the destination of the request - * @param {*} data Request content - * @param {Object=} config Optional configuration object - * @returns {HttpPromise} Future object - */ - createShortMethodsWithData('post', 'put'); - - /** - * @ngdoc property - * @name $http#defaults - * - * @description - * Runtime equivalent of the `$httpProvider.defaults` property. Allows configuration of - * default headers, withCredentials as well as request and response transformations. - * - * See "Setting HTTP Headers" and "Transforming Requests and Responses" sections above. - */ - $http.defaults = defaults; - - - return $http; - - - function createShortMethods(names) { - forEach(arguments, function(name) { - $http[name] = function(url, config) { - return $http(extend(config || {}, { - method: name, - url: url - })); - }; - }); - } - - - function createShortMethodsWithData(name) { - forEach(arguments, function(name) { - $http[name] = function(url, data, config) { - return $http(extend(config || {}, { - method: name, - url: url, - data: data - })); - }; - }); - } - - - /** - * Makes the request. - * - * !!! ACCESSES CLOSURE VARS: - * $httpBackend, defaults, $log, $rootScope, defaultCache, $http.pendingRequests - */ - function sendReq(config, reqData, reqHeaders) { - var deferred = $q.defer(), - promise = deferred.promise, - cache, - cachedResp, - url = buildUrl(config.url, config.params); - - $http.pendingRequests.push(config); - promise.then(removePendingReq, removePendingReq); - - - if ((config.cache || defaults.cache) && config.cache !== false && config.method == 'GET') { - cache = isObject(config.cache) ? config.cache - : isObject(defaults.cache) ? defaults.cache - : defaultCache; - } - - if (cache) { - cachedResp = cache.get(url); - if (isDefined(cachedResp)) { - if (cachedResp.then) { - // cached request has already been sent, but there is no response yet - cachedResp.then(removePendingReq, removePendingReq); - return cachedResp; - } else { - // serving from cache - if (isArray(cachedResp)) { - resolvePromise(cachedResp[1], cachedResp[0], copy(cachedResp[2]), cachedResp[3]); - } else { - resolvePromise(cachedResp, 200, {}, 'OK'); - } - } - } else { - // put the promise for the non-transformed response into cache as a placeholder - cache.put(url, promise); - } - } - - // if we won't have the response in cache, send the request to the backend - if (isUndefined(cachedResp)) { - $httpBackend(config.method, url, reqData, done, reqHeaders, config.timeout, - config.withCredentials, config.responseType); - } - - return promise; - - - /** - * Callback registered to $httpBackend(): - * - caches the response if desired - * - resolves the raw $http promise - * - calls $apply - */ - function done(status, response, headersString, statusText) { - if (cache) { - if (isSuccess(status)) { - cache.put(url, [status, response, parseHeaders(headersString), statusText]); - } else { - // remove promise from the cache - cache.remove(url); - } - } - - resolvePromise(response, status, headersString, statusText); - if (!$rootScope.$$phase) $rootScope.$apply(); - } - - - /** - * Resolves the raw $http promise. - */ - function resolvePromise(response, status, headers, statusText) { - // normalize internal statuses to 0 - status = Math.max(status, 0); - - (isSuccess(status) ? deferred.resolve : deferred.reject)({ - data: response, - status: status, - headers: headersGetter(headers), - config: config, - statusText : statusText - }); - } - - - function removePendingReq() { - var idx = indexOf($http.pendingRequests, config); - if (idx !== -1) $http.pendingRequests.splice(idx, 1); - } - } - - - function buildUrl(url, params) { - if (!params) return url; - var parts = []; - forEachSorted(params, function(value, key) { - if (value === null || isUndefined(value)) return; - if (!isArray(value)) value = [value]; - - forEach(value, function(v) { - if (isObject(v)) { - v = toJson(v); - } - parts.push(encodeUriQuery(key) + '=' + - encodeUriQuery(v)); - }); - }); - if(parts.length > 0) { - url += ((url.indexOf('?') == -1) ? '?' : '&') + parts.join('&'); - } - return url; - } - - - }]; -} - -function createXhr(method) { - //if IE and the method is not RFC2616 compliant, or if XMLHttpRequest - //is not available, try getting an ActiveXObject. Otherwise, use XMLHttpRequest - //if it is available - if (msie <= 8 && (!method.match(/^(get|post|head|put|delete|options)$/i) || - !window.XMLHttpRequest)) { - return new window.ActiveXObject("Microsoft.XMLHTTP"); - } else if (window.XMLHttpRequest) { - return new window.XMLHttpRequest(); - } - - throw minErr('$httpBackend')('noxhr', "This browser does not support XMLHttpRequest."); -} - -/** - * @ngdoc service - * @name $httpBackend - * @requires $window - * @requires $document - * - * @description - * HTTP backend used by the {@link ng.$http service} that delegates to - * XMLHttpRequest object or JSONP and deals with browser incompatibilities. - * - * You should never need to use this service directly, instead use the higher-level abstractions: - * {@link ng.$http $http} or {@link ngResource.$resource $resource}. - * - * During testing this implementation is swapped with {@link ngMock.$httpBackend mock - * $httpBackend} which can be trained with responses. - */ -function $HttpBackendProvider() { - this.$get = ['$browser', '$window', '$document', function($browser, $window, $document) { - return createHttpBackend($browser, createXhr, $browser.defer, $window.angular.callbacks, $document[0]); - }]; -} - -function createHttpBackend($browser, createXhr, $browserDefer, callbacks, rawDocument) { - var ABORTED = -1; - - // TODO(vojta): fix the signature - return function(method, url, post, callback, headers, timeout, withCredentials, responseType) { - var status; - $browser.$$incOutstandingRequestCount(); - url = url || $browser.url(); - - if (lowercase(method) == 'jsonp') { - var callbackId = '_' + (callbacks.counter++).toString(36); - callbacks[callbackId] = function(data) { - callbacks[callbackId].data = data; - }; - - var jsonpDone = jsonpReq(url.replace('JSON_CALLBACK', 'angular.callbacks.' + callbackId), - function() { - if (callbacks[callbackId].data) { - completeRequest(callback, 200, callbacks[callbackId].data); - } else { - completeRequest(callback, status || -2); - } - callbacks[callbackId] = angular.noop; - }); - } else { - - var xhr = createXhr(method); - - xhr.open(method, url, true); - forEach(headers, function(value, key) { - if (isDefined(value)) { - xhr.setRequestHeader(key, value); - } - }); - - // In IE6 and 7, this might be called synchronously when xhr.send below is called and the - // response is in the cache. the promise api will ensure that to the app code the api is - // always async - xhr.onreadystatechange = function() { - // onreadystatechange might get called multiple times with readyState === 4 on mobile webkit caused by - // xhrs that are resolved while the app is in the background (see #5426). - // since calling completeRequest sets the `xhr` variable to null, we just check if it's not null before - // continuing - // - // we can't set xhr.onreadystatechange to undefined or delete it because that breaks IE8 (method=PATCH) and - // Safari respectively. - if (xhr && xhr.readyState == 4) { - var responseHeaders = null, - response = null; - - if(status !== ABORTED) { - responseHeaders = xhr.getAllResponseHeaders(); - - // responseText is the old-school way of retrieving response (supported by IE8 & 9) - // response/responseType properties were introduced in XHR Level2 spec (supported by IE10) - response = ('response' in xhr) ? xhr.response : xhr.responseText; - } - - completeRequest(callback, - status || xhr.status, - response, - responseHeaders, - xhr.statusText || ''); - } - }; - - if (withCredentials) { - xhr.withCredentials = true; - } - - if (responseType) { - try { - xhr.responseType = responseType; - } catch (e) { - // WebKit added support for the json responseType value on 09/03/2013 - // https://bugs.webkit.org/show_bug.cgi?id=73648. Versions of Safari prior to 7 are - // known to throw when setting the value "json" as the response type. Other older - // browsers implementing the responseType - // - // The json response type can be ignored if not supported, because JSON payloads are - // parsed on the client-side regardless. - if (responseType !== 'json') { - throw e; - } - } - } - - xhr.send(post || null); - } - - if (timeout > 0) { - var timeoutId = $browserDefer(timeoutRequest, timeout); - } else if (timeout && timeout.then) { - timeout.then(timeoutRequest); - } - - - function timeoutRequest() { - status = ABORTED; - jsonpDone && jsonpDone(); - xhr && xhr.abort(); - } - - function completeRequest(callback, status, response, headersString, statusText) { - // cancel timeout and subsequent timeout promise resolution - timeoutId && $browserDefer.cancel(timeoutId); - jsonpDone = xhr = null; - - // fix status code when it is 0 (0 status is undocumented). - // Occurs when accessing file resources or on Android 4.1 stock browser - // while retrieving files from application cache. - if (status === 0) { - status = response ? 200 : urlResolve(url).protocol == 'file' ? 404 : 0; - } - - // normalize IE bug (http://bugs.jquery.com/ticket/1450) - status = status === 1223 ? 204 : status; - statusText = statusText || ''; - - callback(status, response, headersString, statusText); - $browser.$$completeOutstandingRequest(noop); - } - }; - - function jsonpReq(url, done) { - // we can't use jQuery/jqLite here because jQuery does crazy shit with script elements, e.g.: - // - fetches local scripts via XHR and evals them - // - adds and immediately removes script elements from the document - var script = rawDocument.createElement('script'), - doneWrapper = function() { - script.onreadystatechange = script.onload = script.onerror = null; - rawDocument.body.removeChild(script); - if (done) done(); - }; - - script.type = 'text/javascript'; - script.src = url; - - if (msie && msie <= 8) { - script.onreadystatechange = function() { - if (/loaded|complete/.test(script.readyState)) { - doneWrapper(); - } - }; - } else { - script.onload = script.onerror = function() { - doneWrapper(); - }; - } - - rawDocument.body.appendChild(script); - return doneWrapper; - } -} - -var $interpolateMinErr = minErr('$interpolate'); - -/** - * @ngdoc provider - * @name $interpolateProvider - * @function - * - * @description - * - * Used for configuring the interpolation markup. Defaults to `{{` and `}}`. - * - * @example - - - -
- //demo.label// -
- - - it('should interpolate binding with custom symbols', function() { - expect(element(by.binding('demo.label')).getText()).toBe('This binding is brought you by // interpolation symbols.'); - }); - - - */ -function $InterpolateProvider() { - var startSymbol = '{{'; - var endSymbol = '}}'; - - /** - * @ngdoc method - * @name $interpolateProvider#startSymbol - * @description - * Symbol to denote start of expression in the interpolated string. Defaults to `{{`. - * - * @param {string=} value new value to set the starting symbol to. - * @returns {string|self} Returns the symbol when used as getter and self if used as setter. - */ - this.startSymbol = function(value){ - if (value) { - startSymbol = value; - return this; - } else { - return startSymbol; - } - }; - - /** - * @ngdoc method - * @name $interpolateProvider#endSymbol - * @description - * Symbol to denote the end of expression in the interpolated string. Defaults to `}}`. - * - * @param {string=} value new value to set the ending symbol to. - * @returns {string|self} Returns the symbol when used as getter and self if used as setter. - */ - this.endSymbol = function(value){ - if (value) { - endSymbol = value; - return this; - } else { - return endSymbol; - } - }; - - - this.$get = ['$parse', '$exceptionHandler', '$sce', function($parse, $exceptionHandler, $sce) { - var startSymbolLength = startSymbol.length, - endSymbolLength = endSymbol.length; - - /** - * @ngdoc service - * @name $interpolate - * @function - * - * @requires $parse - * @requires $sce - * - * @description - * - * Compiles a string with markup into an interpolation function. This service is used by the - * HTML {@link ng.$compile $compile} service for data binding. See - * {@link ng.$interpolateProvider $interpolateProvider} for configuring the - * interpolation markup. - * - * - * ```js - * var $interpolate = ...; // injected - * var exp = $interpolate('Hello {{name | uppercase}}!'); - * expect(exp({name:'Angular'}).toEqual('Hello ANGULAR!'); - * ``` - * - * - * @param {string} text The text with markup to interpolate. - * @param {boolean=} mustHaveExpression if set to true then the interpolation string must have - * embedded expression in order to return an interpolation function. Strings with no - * embedded expression will return null for the interpolation function. - * @param {string=} trustedContext when provided, the returned function passes the interpolated - * result through {@link ng.$sce#getTrusted $sce.getTrusted(interpolatedResult, - * trustedContext)} before returning it. Refer to the {@link ng.$sce $sce} service that - * provides Strict Contextual Escaping for details. - * @returns {function(context)} an interpolation function which is used to compute the - * interpolated string. The function has these parameters: - * - * * `context`: an object against which any expressions embedded in the strings are evaluated - * against. - * - */ - function $interpolate(text, mustHaveExpression, trustedContext) { - var startIndex, - endIndex, - index = 0, - parts = [], - length = text.length, - hasInterpolation = false, - fn, - exp, - concat = []; - - while(index < length) { - if ( ((startIndex = text.indexOf(startSymbol, index)) != -1) && - ((endIndex = text.indexOf(endSymbol, startIndex + startSymbolLength)) != -1) ) { - (index != startIndex) && parts.push(text.substring(index, startIndex)); - parts.push(fn = $parse(exp = text.substring(startIndex + startSymbolLength, endIndex))); - fn.exp = exp; - index = endIndex + endSymbolLength; - hasInterpolation = true; - } else { - // we did not find anything, so we have to add the remainder to the parts array - (index != length) && parts.push(text.substring(index)); - index = length; - } - } - - if (!(length = parts.length)) { - // we added, nothing, must have been an empty string. - parts.push(''); - length = 1; - } - - // Concatenating expressions makes it hard to reason about whether some combination of - // concatenated values are unsafe to use and could easily lead to XSS. By requiring that a - // single expression be used for iframe[src], object[src], etc., we ensure that the value - // that's used is assigned or constructed by some JS code somewhere that is more testable or - // make it obvious that you bound the value to some user controlled value. This helps reduce - // the load when auditing for XSS issues. - if (trustedContext && parts.length > 1) { - throw $interpolateMinErr('noconcat', - "Error while interpolating: {0}\nStrict Contextual Escaping disallows " + - "interpolations that concatenate multiple expressions when a trusted value is " + - "required. See http://docs.angularjs.org/api/ng.$sce", text); - } - - if (!mustHaveExpression || hasInterpolation) { - concat.length = length; - fn = function(context) { - try { - for(var i = 0, ii = length, part; i - * **Note**: Intervals created by this service must be explicitly destroyed when you are finished - * with them. In particular they are not automatically destroyed when a controller's scope or a - * directive's element are destroyed. - * You should take this into consideration and make sure to always cancel the interval at the - * appropriate moment. See the example below for more details on how and when to do this. - * - * - * @param {function()} fn A function that should be called repeatedly. - * @param {number} delay Number of milliseconds between each function call. - * @param {number=} [count=0] Number of times to repeat. If not set, or 0, will repeat - * indefinitely. - * @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise - * will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block. - * @returns {promise} A promise which will be notified on each iteration. - * - * @example - * - * - * - * - *
- *
- * Date format:
- * Current time is: - *
- * Blood 1 : {{blood_1}} - * Blood 2 : {{blood_2}} - * - * - * - *
- *
- * - * - * - */ - function interval(fn, delay, count, invokeApply) { - var setInterval = $window.setInterval, - clearInterval = $window.clearInterval, - deferred = $q.defer(), - promise = deferred.promise, - iteration = 0, - skipApply = (isDefined(invokeApply) && !invokeApply); - - count = isDefined(count) ? count : 0; - - promise.then(null, null, fn); - - promise.$$intervalId = setInterval(function tick() { - deferred.notify(iteration++); - - if (count > 0 && iteration >= count) { - deferred.resolve(iteration); - clearInterval(promise.$$intervalId); - delete intervals[promise.$$intervalId]; - } - - if (!skipApply) $rootScope.$apply(); - - }, delay); - - intervals[promise.$$intervalId] = deferred; - - return promise; - } - - - /** - * @ngdoc method - * @name $interval#cancel - * - * @description - * Cancels a task associated with the `promise`. - * - * @param {promise} promise returned by the `$interval` function. - * @returns {boolean} Returns `true` if the task was successfully canceled. - */ - interval.cancel = function(promise) { - if (promise && promise.$$intervalId in intervals) { - intervals[promise.$$intervalId].reject('canceled'); - clearInterval(promise.$$intervalId); - delete intervals[promise.$$intervalId]; - return true; - } - return false; - }; - - return interval; - }]; -} - -/** - * @ngdoc service - * @name $locale - * - * @description - * $locale service provides localization rules for various Angular components. As of right now the - * only public api is: - * - * * `id` – `{string}` – locale id formatted as `languageId-countryId` (e.g. `en-us`) - */ -function $LocaleProvider(){ - this.$get = function() { - return { - id: 'en-us', - - NUMBER_FORMATS: { - DECIMAL_SEP: '.', - GROUP_SEP: ',', - PATTERNS: [ - { // Decimal Pattern - minInt: 1, - minFrac: 0, - maxFrac: 3, - posPre: '', - posSuf: '', - negPre: '-', - negSuf: '', - gSize: 3, - lgSize: 3 - },{ //Currency Pattern - minInt: 1, - minFrac: 2, - maxFrac: 2, - posPre: '\u00A4', - posSuf: '', - negPre: '(\u00A4', - negSuf: ')', - gSize: 3, - lgSize: 3 - } - ], - CURRENCY_SYM: '$' - }, - - DATETIME_FORMATS: { - MONTH: - 'January,February,March,April,May,June,July,August,September,October,November,December' - .split(','), - SHORTMONTH: 'Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec'.split(','), - DAY: 'Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday'.split(','), - SHORTDAY: 'Sun,Mon,Tue,Wed,Thu,Fri,Sat'.split(','), - AMPMS: ['AM','PM'], - medium: 'MMM d, y h:mm:ss a', - short: 'M/d/yy h:mm a', - fullDate: 'EEEE, MMMM d, y', - longDate: 'MMMM d, y', - mediumDate: 'MMM d, y', - shortDate: 'M/d/yy', - mediumTime: 'h:mm:ss a', - shortTime: 'h:mm a' - }, - - pluralCat: function(num) { - if (num === 1) { - return 'one'; - } - return 'other'; - } - }; - }; -} - -var PATH_MATCH = /^([^\?#]*)(\?([^#]*))?(#(.*))?$/, - DEFAULT_PORTS = {'http': 80, 'https': 443, 'ftp': 21}; -var $locationMinErr = minErr('$location'); - - -/** - * Encode path using encodeUriSegment, ignoring forward slashes - * - * @param {string} path Path to encode - * @returns {string} - */ -function encodePath(path) { - var segments = path.split('/'), - i = segments.length; - - while (i--) { - segments[i] = encodeUriSegment(segments[i]); - } - - return segments.join('/'); -} - -function parseAbsoluteUrl(absoluteUrl, locationObj, appBase) { - var parsedUrl = urlResolve(absoluteUrl, appBase); - - locationObj.$$protocol = parsedUrl.protocol; - locationObj.$$host = parsedUrl.hostname; - locationObj.$$port = int(parsedUrl.port) || DEFAULT_PORTS[parsedUrl.protocol] || null; -} - - -function parseAppUrl(relativeUrl, locationObj, appBase) { - var prefixed = (relativeUrl.charAt(0) !== '/'); - if (prefixed) { - relativeUrl = '/' + relativeUrl; - } - var match = urlResolve(relativeUrl, appBase); - locationObj.$$path = decodeURIComponent(prefixed && match.pathname.charAt(0) === '/' ? - match.pathname.substring(1) : match.pathname); - locationObj.$$search = parseKeyValue(match.search); - locationObj.$$hash = decodeURIComponent(match.hash); - - // make sure path starts with '/'; - if (locationObj.$$path && locationObj.$$path.charAt(0) != '/') { - locationObj.$$path = '/' + locationObj.$$path; - } -} - - -/** - * - * @param {string} begin - * @param {string} whole - * @returns {string} returns text from whole after begin or undefined if it does not begin with - * expected string. - */ -function beginsWith(begin, whole) { - if (whole.indexOf(begin) === 0) { - return whole.substr(begin.length); - } -} - - -function stripHash(url) { - var index = url.indexOf('#'); - return index == -1 ? url : url.substr(0, index); -} - - -function stripFile(url) { - return url.substr(0, stripHash(url).lastIndexOf('/') + 1); -} - -/* return the server only (scheme://host:port) */ -function serverBase(url) { - return url.substring(0, url.indexOf('/', url.indexOf('//') + 2)); -} - - -/** - * LocationHtml5Url represents an url - * This object is exposed as $location service when HTML5 mode is enabled and supported - * - * @constructor - * @param {string} appBase application base URL - * @param {string} basePrefix url path prefix - */ -function LocationHtml5Url(appBase, basePrefix) { - this.$$html5 = true; - basePrefix = basePrefix || ''; - var appBaseNoFile = stripFile(appBase); - parseAbsoluteUrl(appBase, this, appBase); - - - /** - * Parse given html5 (regular) url string into properties - * @param {string} newAbsoluteUrl HTML5 url - * @private - */ - this.$$parse = function(url) { - var pathUrl = beginsWith(appBaseNoFile, url); - if (!isString(pathUrl)) { - throw $locationMinErr('ipthprfx', 'Invalid url "{0}", missing path prefix "{1}".', url, - appBaseNoFile); - } - - parseAppUrl(pathUrl, this, appBase); - - if (!this.$$path) { - this.$$path = '/'; - } - - this.$$compose(); - }; - - /** - * Compose url and update `absUrl` property - * @private - */ - this.$$compose = function() { - var search = toKeyValue(this.$$search), - hash = this.$$hash ? '#' + encodeUriSegment(this.$$hash) : ''; - - this.$$url = encodePath(this.$$path) + (search ? '?' + search : '') + hash; - this.$$absUrl = appBaseNoFile + this.$$url.substr(1); // first char is always '/' - }; - - this.$$rewrite = function(url) { - var appUrl, prevAppUrl; - - if ( (appUrl = beginsWith(appBase, url)) !== undefined ) { - prevAppUrl = appUrl; - if ( (appUrl = beginsWith(basePrefix, appUrl)) !== undefined ) { - return appBaseNoFile + (beginsWith('/', appUrl) || appUrl); - } else { - return appBase + prevAppUrl; - } - } else if ( (appUrl = beginsWith(appBaseNoFile, url)) !== undefined ) { - return appBaseNoFile + appUrl; - } else if (appBaseNoFile == url + '/') { - return appBaseNoFile; - } - }; -} - - -/** - * LocationHashbangUrl represents url - * This object is exposed as $location service when developer doesn't opt into html5 mode. - * It also serves as the base class for html5 mode fallback on legacy browsers. - * - * @constructor - * @param {string} appBase application base URL - * @param {string} hashPrefix hashbang prefix - */ -function LocationHashbangUrl(appBase, hashPrefix) { - var appBaseNoFile = stripFile(appBase); - - parseAbsoluteUrl(appBase, this, appBase); - - - /** - * Parse given hashbang url into properties - * @param {string} url Hashbang url - * @private - */ - this.$$parse = function(url) { - var withoutBaseUrl = beginsWith(appBase, url) || beginsWith(appBaseNoFile, url); - var withoutHashUrl = withoutBaseUrl.charAt(0) == '#' - ? beginsWith(hashPrefix, withoutBaseUrl) - : (this.$$html5) - ? withoutBaseUrl - : ''; - - if (!isString(withoutHashUrl)) { - throw $locationMinErr('ihshprfx', 'Invalid url "{0}", missing hash prefix "{1}".', url, - hashPrefix); - } - parseAppUrl(withoutHashUrl, this, appBase); - - this.$$path = removeWindowsDriveName(this.$$path, withoutHashUrl, appBase); - - this.$$compose(); - - /* - * In Windows, on an anchor node on documents loaded from - * the filesystem, the browser will return a pathname - * prefixed with the drive name ('/C:/path') when a - * pathname without a drive is set: - * * a.setAttribute('href', '/foo') - * * a.pathname === '/C:/foo' //true - * - * Inside of Angular, we're always using pathnames that - * do not include drive names for routing. - */ - function removeWindowsDriveName (path, url, base) { - /* - Matches paths for file protocol on windows, - such as /C:/foo/bar, and captures only /foo/bar. - */ - var windowsFilePathExp = /^\/?.*?:(\/.*)/; - - var firstPathSegmentMatch; - - //Get the relative path from the input URL. - if (url.indexOf(base) === 0) { - url = url.replace(base, ''); - } - - /* - * The input URL intentionally contains a - * first path segment that ends with a colon. - */ - if (windowsFilePathExp.exec(url)) { - return path; - } - - firstPathSegmentMatch = windowsFilePathExp.exec(path); - return firstPathSegmentMatch ? firstPathSegmentMatch[1] : path; - } - }; - - /** - * Compose hashbang url and update `absUrl` property - * @private - */ - this.$$compose = function() { - var search = toKeyValue(this.$$search), - hash = this.$$hash ? '#' + encodeUriSegment(this.$$hash) : ''; - - this.$$url = encodePath(this.$$path) + (search ? '?' + search : '') + hash; - this.$$absUrl = appBase + (this.$$url ? hashPrefix + this.$$url : ''); - }; - - this.$$rewrite = function(url) { - if(stripHash(appBase) == stripHash(url)) { - return url; - } - }; -} - - -/** - * LocationHashbangUrl represents url - * This object is exposed as $location service when html5 history api is enabled but the browser - * does not support it. - * - * @constructor - * @param {string} appBase application base URL - * @param {string} hashPrefix hashbang prefix - */ -function LocationHashbangInHtml5Url(appBase, hashPrefix) { - this.$$html5 = true; - LocationHashbangUrl.apply(this, arguments); - - var appBaseNoFile = stripFile(appBase); - - this.$$rewrite = function(url) { - var appUrl; - - if ( appBase == stripHash(url) ) { - return url; - } else if ( (appUrl = beginsWith(appBaseNoFile, url)) ) { - return appBase + hashPrefix + appUrl; - } else if ( appBaseNoFile === url + '/') { - return appBaseNoFile; - } - }; -} - - -LocationHashbangInHtml5Url.prototype = - LocationHashbangUrl.prototype = - LocationHtml5Url.prototype = { - - /** - * Are we in html5 mode? - * @private - */ - $$html5: false, - - /** - * Has any change been replacing ? - * @private - */ - $$replace: false, - - /** - * @ngdoc method - * @name $location#absUrl - * - * @description - * This method is getter only. - * - * Return full url representation with all segments encoded according to rules specified in - * [RFC 3986](http://www.ietf.org/rfc/rfc3986.txt). - * - * @return {string} full url - */ - absUrl: locationGetter('$$absUrl'), - - /** - * @ngdoc method - * @name $location#url - * - * @description - * This method is getter / setter. - * - * Return url (e.g. `/path?a=b#hash`) when called without any parameter. - * - * Change path, search and hash, when called with parameter and return `$location`. - * - * @param {string=} url New url without base prefix (e.g. `/path?a=b#hash`) - * @param {string=} replace The path that will be changed - * @return {string} url - */ - url: function(url, replace) { - if (isUndefined(url)) - return this.$$url; - - var match = PATH_MATCH.exec(url); - if (match[1]) this.path(decodeURIComponent(match[1])); - if (match[2] || match[1]) this.search(match[3] || ''); - this.hash(match[5] || '', replace); - - return this; - }, - - /** - * @ngdoc method - * @name $location#protocol - * - * @description - * This method is getter only. - * - * Return protocol of current url. - * - * @return {string} protocol of current url - */ - protocol: locationGetter('$$protocol'), - - /** - * @ngdoc method - * @name $location#host - * - * @description - * This method is getter only. - * - * Return host of current url. - * - * @return {string} host of current url. - */ - host: locationGetter('$$host'), - - /** - * @ngdoc method - * @name $location#port - * - * @description - * This method is getter only. - * - * Return port of current url. - * - * @return {Number} port - */ - port: locationGetter('$$port'), - - /** - * @ngdoc method - * @name $location#path - * - * @description - * This method is getter / setter. - * - * Return path of current url when called without any parameter. - * - * Change path when called with parameter and return `$location`. - * - * Note: Path should always begin with forward slash (/), this method will add the forward slash - * if it is missing. - * - * @param {string=} path New path - * @return {string} path - */ - path: locationGetterSetter('$$path', function(path) { - return path.charAt(0) == '/' ? path : '/' + path; - }), - - /** - * @ngdoc method - * @name $location#search - * - * @description - * This method is getter / setter. - * - * Return search part (as object) of current url when called without any parameter. - * - * Change search part when called with parameter and return `$location`. - * - * @param {string|Object.|Object.>} search New search params - string or - * hash object. Hash object may contain an array of values, which will be decoded as duplicates in - * the url. - * - * @param {(string|Array)=} paramValue If `search` is a string, then `paramValue` will override only a - * single search parameter. If `paramValue` is an array, it will set the parameter as a - * comma-separated value. If `paramValue` is `null`, the parameter will be deleted. - * - * @return {string} search - */ - search: function(search, paramValue) { - switch (arguments.length) { - case 0: - return this.$$search; - case 1: - if (isString(search)) { - this.$$search = parseKeyValue(search); - } else if (isObject(search)) { - this.$$search = search; - } else { - throw $locationMinErr('isrcharg', - 'The first argument of the `$location#search()` call must be a string or an object.'); - } - break; - default: - if (isUndefined(paramValue) || paramValue === null) { - delete this.$$search[search]; - } else { - this.$$search[search] = paramValue; - } - } - - this.$$compose(); - return this; - }, - - /** - * @ngdoc method - * @name $location#hash - * - * @description - * This method is getter / setter. - * - * Return hash fragment when called without any parameter. - * - * Change hash fragment when called with parameter and return `$location`. - * - * @param {string=} hash New hash fragment - * @return {string} hash - */ - hash: locationGetterSetter('$$hash', identity), - - /** - * @ngdoc method - * @name $location#replace - * - * @description - * If called, all changes to $location during current `$digest` will be replacing current history - * record, instead of adding new one. - */ - replace: function() { - this.$$replace = true; - return this; - } -}; - -function locationGetter(property) { - return function() { - return this[property]; - }; -} - - -function locationGetterSetter(property, preprocess) { - return function(value) { - if (isUndefined(value)) - return this[property]; - - this[property] = preprocess(value); - this.$$compose(); - - return this; - }; -} - - -/** - * @ngdoc service - * @name $location - * - * @requires $rootElement - * - * @description - * The $location service parses the URL in the browser address bar (based on the - * [window.location](https://developer.mozilla.org/en/window.location)) and makes the URL - * available to your application. Changes to the URL in the address bar are reflected into - * $location service and changes to $location are reflected into the browser address bar. - * - * **The $location service:** - * - * - Exposes the current URL in the browser address bar, so you can - * - Watch and observe the URL. - * - Change the URL. - * - Synchronizes the URL with the browser when the user - * - Changes the address bar. - * - Clicks the back or forward button (or clicks a History link). - * - Clicks on a link. - * - Represents the URL object as a set of methods (protocol, host, port, path, search, hash). - * - * For more information see {@link guide/$location Developer Guide: Using $location} - */ - -/** - * @ngdoc provider - * @name $locationProvider - * @description - * Use the `$locationProvider` to configure how the application deep linking paths are stored. - */ -function $LocationProvider(){ - var hashPrefix = '', - html5Mode = false; - - /** - * @ngdoc property - * @name $locationProvider#hashPrefix - * @description - * @param {string=} prefix Prefix for hash part (containing path and search) - * @returns {*} current value if used as getter or itself (chaining) if used as setter - */ - this.hashPrefix = function(prefix) { - if (isDefined(prefix)) { - hashPrefix = prefix; - return this; - } else { - return hashPrefix; - } - }; - - /** - * @ngdoc property - * @name $locationProvider#html5Mode - * @description - * @param {boolean=} mode Use HTML5 strategy if available. - * @returns {*} current value if used as getter or itself (chaining) if used as setter - */ - this.html5Mode = function(mode) { - if (isDefined(mode)) { - html5Mode = mode; - return this; - } else { - return html5Mode; - } - }; - - /** - * @ngdoc event - * @name $location#$locationChangeStart - * @eventType broadcast on root scope - * @description - * Broadcasted before a URL will change. This change can be prevented by calling - * `preventDefault` method of the event. See {@link ng.$rootScope.Scope#$on} for more - * details about event object. Upon successful change - * {@link ng.$location#events_$locationChangeSuccess $locationChangeSuccess} is fired. - * - * @param {Object} angularEvent Synthetic event object. - * @param {string} newUrl New URL - * @param {string=} oldUrl URL that was before it was changed. - */ - - /** - * @ngdoc event - * @name $location#$locationChangeSuccess - * @eventType broadcast on root scope - * @description - * Broadcasted after a URL was changed. - * - * @param {Object} angularEvent Synthetic event object. - * @param {string} newUrl New URL - * @param {string=} oldUrl URL that was before it was changed. - */ - - this.$get = ['$rootScope', '$browser', '$sniffer', '$rootElement', - function( $rootScope, $browser, $sniffer, $rootElement) { - var $location, - LocationMode, - baseHref = $browser.baseHref(), // if base[href] is undefined, it defaults to '' - initialUrl = $browser.url(), - appBase; - - if (html5Mode) { - appBase = serverBase(initialUrl) + (baseHref || '/'); - LocationMode = $sniffer.history ? LocationHtml5Url : LocationHashbangInHtml5Url; - } else { - appBase = stripHash(initialUrl); - LocationMode = LocationHashbangUrl; - } - $location = new LocationMode(appBase, '#' + hashPrefix); - $location.$$parse($location.$$rewrite(initialUrl)); - - $rootElement.on('click', function(event) { - // TODO(vojta): rewrite link when opening in new tab/window (in legacy browser) - // currently we open nice url link and redirect then - - if (event.ctrlKey || event.metaKey || event.which == 2) return; - - var elm = jqLite(event.target); - - // traverse the DOM up to find first A tag - while (lowercase(elm[0].nodeName) !== 'a') { - // ignore rewriting if no A tag (reached root element, or no parent - removed from document) - if (elm[0] === $rootElement[0] || !(elm = elm.parent())[0]) return; - } - - var absHref = elm.prop('href'); - - if (isObject(absHref) && absHref.toString() === '[object SVGAnimatedString]') { - // SVGAnimatedString.animVal should be identical to SVGAnimatedString.baseVal, unless during - // an animation. - absHref = urlResolve(absHref.animVal).href; - } - - var rewrittenUrl = $location.$$rewrite(absHref); - - if (absHref && !elm.attr('target') && rewrittenUrl && !event.isDefaultPrevented()) { - event.preventDefault(); - if (rewrittenUrl != $browser.url()) { - // update location manually - $location.$$parse(rewrittenUrl); - $rootScope.$apply(); - // hack to work around FF6 bug 684208 when scenario runner clicks on links - window.angular['ff-684208-preventDefault'] = true; - } - } - }); - - - // rewrite hashbang url <> html5 url - if ($location.absUrl() != initialUrl) { - $browser.url($location.absUrl(), true); - } - - // update $location when $browser url changes - $browser.onUrlChange(function(newUrl) { - if ($location.absUrl() != newUrl) { - $rootScope.$evalAsync(function() { - var oldUrl = $location.absUrl(); - - $location.$$parse(newUrl); - if ($rootScope.$broadcast('$locationChangeStart', newUrl, - oldUrl).defaultPrevented) { - $location.$$parse(oldUrl); - $browser.url(oldUrl); - } else { - afterLocationChange(oldUrl); - } - }); - if (!$rootScope.$$phase) $rootScope.$digest(); - } - }); - - // update browser - var changeCounter = 0; - $rootScope.$watch(function $locationWatch() { - var oldUrl = $browser.url(); - var currentReplace = $location.$$replace; - - if (!changeCounter || oldUrl != $location.absUrl()) { - changeCounter++; - $rootScope.$evalAsync(function() { - if ($rootScope.$broadcast('$locationChangeStart', $location.absUrl(), oldUrl). - defaultPrevented) { - $location.$$parse(oldUrl); - } else { - $browser.url($location.absUrl(), currentReplace); - afterLocationChange(oldUrl); - } - }); - } - $location.$$replace = false; - - return changeCounter; - }); - - return $location; - - function afterLocationChange(oldUrl) { - $rootScope.$broadcast('$locationChangeSuccess', $location.absUrl(), oldUrl); - } -}]; -} - -/** - * @ngdoc service - * @name $log - * @requires $window - * - * @description - * Simple service for logging. Default implementation safely writes the message - * into the browser's console (if present). - * - * The main purpose of this service is to simplify debugging and troubleshooting. - * - * The default is to log `debug` messages. You can use - * {@link ng.$logProvider ng.$logProvider#debugEnabled} to change this. - * - * @example - - - function LogCtrl($scope, $log) { - $scope.$log = $log; - $scope.message = 'Hello World!'; - } - - -
-

Reload this page with open console, enter text and hit the log button...

- Message: - - - - - -
- - - */ - -/** - * @ngdoc provider - * @name $logProvider - * @description - * Use the `$logProvider` to configure how the application logs messages - */ -function $LogProvider(){ - var debug = true, - self = this; - - /** - * @ngdoc property - * @name $logProvider#debugEnabled - * @description - * @param {boolean=} flag enable or disable debug level messages - * @returns {*} current value if used as getter or itself (chaining) if used as setter - */ - this.debugEnabled = function(flag) { - if (isDefined(flag)) { - debug = flag; - return this; - } else { - return debug; - } - }; - - this.$get = ['$window', function($window){ - return { - /** - * @ngdoc method - * @name $log#log - * - * @description - * Write a log message - */ - log: consoleLog('log'), - - /** - * @ngdoc method - * @name $log#info - * - * @description - * Write an information message - */ - info: consoleLog('info'), - - /** - * @ngdoc method - * @name $log#warn - * - * @description - * Write a warning message - */ - warn: consoleLog('warn'), - - /** - * @ngdoc method - * @name $log#error - * - * @description - * Write an error message - */ - error: consoleLog('error'), - - /** - * @ngdoc method - * @name $log#debug - * - * @description - * Write a debug message - */ - debug: (function () { - var fn = consoleLog('debug'); - - return function() { - if (debug) { - fn.apply(self, arguments); - } - }; - }()) - }; - - function formatError(arg) { - if (arg instanceof Error) { - if (arg.stack) { - arg = (arg.message && arg.stack.indexOf(arg.message) === -1) - ? 'Error: ' + arg.message + '\n' + arg.stack - : arg.stack; - } else if (arg.sourceURL) { - arg = arg.message + '\n' + arg.sourceURL + ':' + arg.line; - } - } - return arg; - } - - function consoleLog(type) { - var console = $window.console || {}, - logFn = console[type] || console.log || noop, - hasApply = false; - - // Note: reading logFn.apply throws an error in IE11 in IE8 document mode. - // The reason behind this is that console.log has type "object" in IE8... - try { - hasApply = !!logFn.apply; - } catch (e) {} - - if (hasApply) { - return function() { - var args = []; - forEach(arguments, function(arg) { - args.push(formatError(arg)); - }); - return logFn.apply(console, args); - }; - } - - // we are IE which either doesn't have window.console => this is noop and we do nothing, - // or we are IE where console.log doesn't have apply so we log at least first 2 args - return function(arg1, arg2) { - logFn(arg1, arg2 == null ? '' : arg2); - }; - } - }]; -} - -var $parseMinErr = minErr('$parse'); -var promiseWarningCache = {}; -var promiseWarning; - -// Sandboxing Angular Expressions -// ------------------------------ -// Angular expressions are generally considered safe because these expressions only have direct -// access to $scope and locals. However, one can obtain the ability to execute arbitrary JS code by -// obtaining a reference to native JS functions such as the Function constructor. -// -// As an example, consider the following Angular expression: -// -// {}.toString.constructor(alert("evil JS code")) -// -// We want to prevent this type of access. For the sake of performance, during the lexing phase we -// disallow any "dotted" access to any member named "constructor". -// -// For reflective calls (a[b]) we check that the value of the lookup is not the Function constructor -// while evaluating the expression, which is a stronger but more expensive test. Since reflective -// calls are expensive anyway, this is not such a big deal compared to static dereferencing. -// -// This sandboxing technique is not perfect and doesn't aim to be. The goal is to prevent exploits -// against the expression language, but not to prevent exploits that were enabled by exposing -// sensitive JavaScript or browser apis on Scope. Exposing such objects on a Scope is never a good -// practice and therefore we are not even trying to protect against interaction with an object -// explicitly exposed in this way. -// -// A developer could foil the name check by aliasing the Function constructor under a different -// name on the scope. -// -// In general, it is not possible to access a Window object from an angular expression unless a -// window or some DOM object that has a reference to window is published onto a Scope. - -function ensureSafeMemberName(name, fullExpression) { - if (name === "constructor") { - throw $parseMinErr('isecfld', - 'Referencing "constructor" field in Angular expressions is disallowed! Expression: {0}', - fullExpression); - } - return name; -} - -function ensureSafeObject(obj, fullExpression) { - // nifty check if obj is Function that is fast and works across iframes and other contexts - if (obj) { - if (obj.constructor === obj) { - throw $parseMinErr('isecfn', - 'Referencing Function in Angular expressions is disallowed! Expression: {0}', - fullExpression); - } else if (// isWindow(obj) - obj.document && obj.location && obj.alert && obj.setInterval) { - throw $parseMinErr('isecwindow', - 'Referencing the Window in Angular expressions is disallowed! Expression: {0}', - fullExpression); - } else if (// isElement(obj) - obj.children && (obj.nodeName || (obj.prop && obj.attr && obj.find))) { - throw $parseMinErr('isecdom', - 'Referencing DOM nodes in Angular expressions is disallowed! Expression: {0}', - fullExpression); - } - } - return obj; -} - -var OPERATORS = { - /* jshint bitwise : false */ - 'null':function(){return null;}, - 'true':function(){return true;}, - 'false':function(){return false;}, - undefined:noop, - '+':function(self, locals, a,b){ - a=a(self, locals); b=b(self, locals); - if (isDefined(a)) { - if (isDefined(b)) { - return a + b; - } - return a; - } - return isDefined(b)?b:undefined;}, - '-':function(self, locals, a,b){ - a=a(self, locals); b=b(self, locals); - return (isDefined(a)?a:0)-(isDefined(b)?b:0); - }, - '*':function(self, locals, a,b){return a(self, locals)*b(self, locals);}, - '/':function(self, locals, a,b){return a(self, locals)/b(self, locals);}, - '%':function(self, locals, a,b){return a(self, locals)%b(self, locals);}, - '^':function(self, locals, a,b){return a(self, locals)^b(self, locals);}, - '=':noop, - '===':function(self, locals, a, b){return a(self, locals)===b(self, locals);}, - '!==':function(self, locals, a, b){return a(self, locals)!==b(self, locals);}, - '==':function(self, locals, a,b){return a(self, locals)==b(self, locals);}, - '!=':function(self, locals, a,b){return a(self, locals)!=b(self, locals);}, - '<':function(self, locals, a,b){return a(self, locals)':function(self, locals, a,b){return a(self, locals)>b(self, locals);}, - '<=':function(self, locals, a,b){return a(self, locals)<=b(self, locals);}, - '>=':function(self, locals, a,b){return a(self, locals)>=b(self, locals);}, - '&&':function(self, locals, a,b){return a(self, locals)&&b(self, locals);}, - '||':function(self, locals, a,b){return a(self, locals)||b(self, locals);}, - '&':function(self, locals, a,b){return a(self, locals)&b(self, locals);}, -// '|':function(self, locals, a,b){return a|b;}, - '|':function(self, locals, a,b){return b(self, locals)(self, locals, a(self, locals));}, - '!':function(self, locals, a){return !a(self, locals);} -}; -/* jshint bitwise: true */ -var ESCAPE = {"n":"\n", "f":"\f", "r":"\r", "t":"\t", "v":"\v", "'":"'", '"':'"'}; - - -///////////////////////////////////////// - - -/** - * @constructor - */ -var Lexer = function (options) { - this.options = options; -}; - -Lexer.prototype = { - constructor: Lexer, - - lex: function (text) { - this.text = text; - - this.index = 0; - this.ch = undefined; - this.lastCh = ':'; // can start regexp - - this.tokens = []; - - var token; - var json = []; - - while (this.index < this.text.length) { - this.ch = this.text.charAt(this.index); - if (this.is('"\'')) { - this.readString(this.ch); - } else if (this.isNumber(this.ch) || this.is('.') && this.isNumber(this.peek())) { - this.readNumber(); - } else if (this.isIdent(this.ch)) { - this.readIdent(); - // identifiers can only be if the preceding char was a { or , - if (this.was('{,') && json[0] === '{' && - (token = this.tokens[this.tokens.length - 1])) { - token.json = token.text.indexOf('.') === -1; - } - } else if (this.is('(){}[].,;:?')) { - this.tokens.push({ - index: this.index, - text: this.ch, - json: (this.was(':[,') && this.is('{[')) || this.is('}]:,') - }); - if (this.is('{[')) json.unshift(this.ch); - if (this.is('}]')) json.shift(); - this.index++; - } else if (this.isWhitespace(this.ch)) { - this.index++; - continue; - } else { - var ch2 = this.ch + this.peek(); - var ch3 = ch2 + this.peek(2); - var fn = OPERATORS[this.ch]; - var fn2 = OPERATORS[ch2]; - var fn3 = OPERATORS[ch3]; - if (fn3) { - this.tokens.push({index: this.index, text: ch3, fn: fn3}); - this.index += 3; - } else if (fn2) { - this.tokens.push({index: this.index, text: ch2, fn: fn2}); - this.index += 2; - } else if (fn) { - this.tokens.push({ - index: this.index, - text: this.ch, - fn: fn, - json: (this.was('[,:') && this.is('+-')) - }); - this.index += 1; - } else { - this.throwError('Unexpected next character ', this.index, this.index + 1); - } - } - this.lastCh = this.ch; - } - return this.tokens; - }, - - is: function(chars) { - return chars.indexOf(this.ch) !== -1; - }, - - was: function(chars) { - return chars.indexOf(this.lastCh) !== -1; - }, - - peek: function(i) { - var num = i || 1; - return (this.index + num < this.text.length) ? this.text.charAt(this.index + num) : false; - }, - - isNumber: function(ch) { - return ('0' <= ch && ch <= '9'); - }, - - isWhitespace: function(ch) { - // IE treats non-breaking space as \u00A0 - return (ch === ' ' || ch === '\r' || ch === '\t' || - ch === '\n' || ch === '\v' || ch === '\u00A0'); - }, - - isIdent: function(ch) { - return ('a' <= ch && ch <= 'z' || - 'A' <= ch && ch <= 'Z' || - '_' === ch || ch === '$'); - }, - - isExpOperator: function(ch) { - return (ch === '-' || ch === '+' || this.isNumber(ch)); - }, - - throwError: function(error, start, end) { - end = end || this.index; - var colStr = (isDefined(start) - ? 's ' + start + '-' + this.index + ' [' + this.text.substring(start, end) + ']' - : ' ' + end); - throw $parseMinErr('lexerr', 'Lexer Error: {0} at column{1} in expression [{2}].', - error, colStr, this.text); - }, - - readNumber: function() { - var number = ''; - var start = this.index; - while (this.index < this.text.length) { - var ch = lowercase(this.text.charAt(this.index)); - if (ch == '.' || this.isNumber(ch)) { - number += ch; - } else { - var peekCh = this.peek(); - if (ch == 'e' && this.isExpOperator(peekCh)) { - number += ch; - } else if (this.isExpOperator(ch) && - peekCh && this.isNumber(peekCh) && - number.charAt(number.length - 1) == 'e') { - number += ch; - } else if (this.isExpOperator(ch) && - (!peekCh || !this.isNumber(peekCh)) && - number.charAt(number.length - 1) == 'e') { - this.throwError('Invalid exponent'); - } else { - break; - } - } - this.index++; - } - number = 1 * number; - this.tokens.push({ - index: start, - text: number, - json: true, - fn: function() { return number; } - }); - }, - - readIdent: function() { - var parser = this; - - var ident = ''; - var start = this.index; - - var lastDot, peekIndex, methodName, ch; - - while (this.index < this.text.length) { - ch = this.text.charAt(this.index); - if (ch === '.' || this.isIdent(ch) || this.isNumber(ch)) { - if (ch === '.') lastDot = this.index; - ident += ch; - } else { - break; - } - this.index++; - } - - //check if this is not a method invocation and if it is back out to last dot - if (lastDot) { - peekIndex = this.index; - while (peekIndex < this.text.length) { - ch = this.text.charAt(peekIndex); - if (ch === '(') { - methodName = ident.substr(lastDot - start + 1); - ident = ident.substr(0, lastDot - start); - this.index = peekIndex; - break; - } - if (this.isWhitespace(ch)) { - peekIndex++; - } else { - break; - } - } - } - - - var token = { - index: start, - text: ident - }; - - // OPERATORS is our own object so we don't need to use special hasOwnPropertyFn - if (OPERATORS.hasOwnProperty(ident)) { - token.fn = OPERATORS[ident]; - token.json = OPERATORS[ident]; - } else { - var getter = getterFn(ident, this.options, this.text); - token.fn = extend(function(self, locals) { - return (getter(self, locals)); - }, { - assign: function(self, value) { - return setter(self, ident, value, parser.text, parser.options); - } - }); - } - - this.tokens.push(token); - - if (methodName) { - this.tokens.push({ - index:lastDot, - text: '.', - json: false - }); - this.tokens.push({ - index: lastDot + 1, - text: methodName, - json: false - }); - } - }, - - readString: function(quote) { - var start = this.index; - this.index++; - var string = ''; - var rawString = quote; - var escape = false; - while (this.index < this.text.length) { - var ch = this.text.charAt(this.index); - rawString += ch; - if (escape) { - if (ch === 'u') { - var hex = this.text.substring(this.index + 1, this.index + 5); - if (!hex.match(/[\da-f]{4}/i)) - this.throwError('Invalid unicode escape [\\u' + hex + ']'); - this.index += 4; - string += String.fromCharCode(parseInt(hex, 16)); - } else { - var rep = ESCAPE[ch]; - if (rep) { - string += rep; - } else { - string += ch; - } - } - escape = false; - } else if (ch === '\\') { - escape = true; - } else if (ch === quote) { - this.index++; - this.tokens.push({ - index: start, - text: rawString, - string: string, - json: true, - fn: function() { return string; } - }); - return; - } else { - string += ch; - } - this.index++; - } - this.throwError('Unterminated quote', start); - } -}; - - -/** - * @constructor - */ -var Parser = function (lexer, $filter, options) { - this.lexer = lexer; - this.$filter = $filter; - this.options = options; -}; - -Parser.ZERO = extend(function () { - return 0; -}, { - constant: true -}); - -Parser.prototype = { - constructor: Parser, - - parse: function (text, json) { - this.text = text; - - //TODO(i): strip all the obsolte json stuff from this file - this.json = json; - - this.tokens = this.lexer.lex(text); - - if (json) { - // The extra level of aliasing is here, just in case the lexer misses something, so that - // we prevent any accidental execution in JSON. - this.assignment = this.logicalOR; - - this.functionCall = - this.fieldAccess = - this.objectIndex = - this.filterChain = function() { - this.throwError('is not valid json', {text: text, index: 0}); - }; - } - - var value = json ? this.primary() : this.statements(); - - if (this.tokens.length !== 0) { - this.throwError('is an unexpected token', this.tokens[0]); - } - - value.literal = !!value.literal; - value.constant = !!value.constant; - - return value; - }, - - primary: function () { - var primary; - if (this.expect('(')) { - primary = this.filterChain(); - this.consume(')'); - } else if (this.expect('[')) { - primary = this.arrayDeclaration(); - } else if (this.expect('{')) { - primary = this.object(); - } else { - var token = this.expect(); - primary = token.fn; - if (!primary) { - this.throwError('not a primary expression', token); - } - if (token.json) { - primary.constant = true; - primary.literal = true; - } - } - - var next, context; - while ((next = this.expect('(', '[', '.'))) { - if (next.text === '(') { - primary = this.functionCall(primary, context); - context = null; - } else if (next.text === '[') { - context = primary; - primary = this.objectIndex(primary); - } else if (next.text === '.') { - context = primary; - primary = this.fieldAccess(primary); - } else { - this.throwError('IMPOSSIBLE'); - } - } - return primary; - }, - - throwError: function(msg, token) { - throw $parseMinErr('syntax', - 'Syntax Error: Token \'{0}\' {1} at column {2} of the expression [{3}] starting at [{4}].', - token.text, msg, (token.index + 1), this.text, this.text.substring(token.index)); - }, - - peekToken: function() { - if (this.tokens.length === 0) - throw $parseMinErr('ueoe', 'Unexpected end of expression: {0}', this.text); - return this.tokens[0]; - }, - - peek: function(e1, e2, e3, e4) { - if (this.tokens.length > 0) { - var token = this.tokens[0]; - var t = token.text; - if (t === e1 || t === e2 || t === e3 || t === e4 || - (!e1 && !e2 && !e3 && !e4)) { - return token; - } - } - return false; - }, - - expect: function(e1, e2, e3, e4){ - var token = this.peek(e1, e2, e3, e4); - if (token) { - if (this.json && !token.json) { - this.throwError('is not valid json', token); - } - this.tokens.shift(); - return token; - } - return false; - }, - - consume: function(e1){ - if (!this.expect(e1)) { - this.throwError('is unexpected, expecting [' + e1 + ']', this.peek()); - } - }, - - unaryFn: function(fn, right) { - return extend(function(self, locals) { - return fn(self, locals, right); - }, { - constant:right.constant - }); - }, - - ternaryFn: function(left, middle, right){ - return extend(function(self, locals){ - return left(self, locals) ? middle(self, locals) : right(self, locals); - }, { - constant: left.constant && middle.constant && right.constant - }); - }, - - binaryFn: function(left, fn, right) { - return extend(function(self, locals) { - return fn(self, locals, left, right); - }, { - constant:left.constant && right.constant - }); - }, - - statements: function() { - var statements = []; - while (true) { - if (this.tokens.length > 0 && !this.peek('}', ')', ';', ']')) - statements.push(this.filterChain()); - if (!this.expect(';')) { - // optimize for the common case where there is only one statement. - // TODO(size): maybe we should not support multiple statements? - return (statements.length === 1) - ? statements[0] - : function(self, locals) { - var value; - for (var i = 0; i < statements.length; i++) { - var statement = statements[i]; - if (statement) { - value = statement(self, locals); - } - } - return value; - }; - } - } - }, - - filterChain: function() { - var left = this.expression(); - var token; - while (true) { - if ((token = this.expect('|'))) { - left = this.binaryFn(left, token.fn, this.filter()); - } else { - return left; - } - } - }, - - filter: function() { - var token = this.expect(); - var fn = this.$filter(token.text); - var argsFn = []; - while (true) { - if ((token = this.expect(':'))) { - argsFn.push(this.expression()); - } else { - var fnInvoke = function(self, locals, input) { - var args = [input]; - for (var i = 0; i < argsFn.length; i++) { - args.push(argsFn[i](self, locals)); - } - return fn.apply(self, args); - }; - return function() { - return fnInvoke; - }; - } - } - }, - - expression: function() { - return this.assignment(); - }, - - assignment: function() { - var left = this.ternary(); - var right; - var token; - if ((token = this.expect('='))) { - if (!left.assign) { - this.throwError('implies assignment but [' + - this.text.substring(0, token.index) + '] can not be assigned to', token); - } - right = this.ternary(); - return function(scope, locals) { - return left.assign(scope, right(scope, locals), locals); - }; - } - return left; - }, - - ternary: function() { - var left = this.logicalOR(); - var middle; - var token; - if ((token = this.expect('?'))) { - middle = this.ternary(); - if ((token = this.expect(':'))) { - return this.ternaryFn(left, middle, this.ternary()); - } else { - this.throwError('expected :', token); - } - } else { - return left; - } - }, - - logicalOR: function() { - var left = this.logicalAND(); - var token; - while (true) { - if ((token = this.expect('||'))) { - left = this.binaryFn(left, token.fn, this.logicalAND()); - } else { - return left; - } - } - }, - - logicalAND: function() { - var left = this.equality(); - var token; - if ((token = this.expect('&&'))) { - left = this.binaryFn(left, token.fn, this.logicalAND()); - } - return left; - }, - - equality: function() { - var left = this.relational(); - var token; - if ((token = this.expect('==','!=','===','!=='))) { - left = this.binaryFn(left, token.fn, this.equality()); - } - return left; - }, - - relational: function() { - var left = this.additive(); - var token; - if ((token = this.expect('<', '>', '<=', '>='))) { - left = this.binaryFn(left, token.fn, this.relational()); - } - return left; - }, - - additive: function() { - var left = this.multiplicative(); - var token; - while ((token = this.expect('+','-'))) { - left = this.binaryFn(left, token.fn, this.multiplicative()); - } - return left; - }, - - multiplicative: function() { - var left = this.unary(); - var token; - while ((token = this.expect('*','/','%'))) { - left = this.binaryFn(left, token.fn, this.unary()); - } - return left; - }, - - unary: function() { - var token; - if (this.expect('+')) { - return this.primary(); - } else if ((token = this.expect('-'))) { - return this.binaryFn(Parser.ZERO, token.fn, this.unary()); - } else if ((token = this.expect('!'))) { - return this.unaryFn(token.fn, this.unary()); - } else { - return this.primary(); - } - }, - - fieldAccess: function(object) { - var parser = this; - var field = this.expect().text; - var getter = getterFn(field, this.options, this.text); - - return extend(function(scope, locals, self) { - return getter(self || object(scope, locals)); - }, { - assign: function(scope, value, locals) { - return setter(object(scope, locals), field, value, parser.text, parser.options); - } - }); - }, - - objectIndex: function(obj) { - var parser = this; - - var indexFn = this.expression(); - this.consume(']'); - - return extend(function(self, locals) { - var o = obj(self, locals), - i = indexFn(self, locals), - v, p; - - if (!o) return undefined; - v = ensureSafeObject(o[i], parser.text); - if (v && v.then && parser.options.unwrapPromises) { - p = v; - if (!('$$v' in v)) { - p.$$v = undefined; - p.then(function(val) { p.$$v = val; }); - } - v = v.$$v; - } - return v; - }, { - assign: function(self, value, locals) { - var key = indexFn(self, locals); - // prevent overwriting of Function.constructor which would break ensureSafeObject check - var safe = ensureSafeObject(obj(self, locals), parser.text); - return safe[key] = value; - } - }); - }, - - functionCall: function(fn, contextGetter) { - var argsFn = []; - if (this.peekToken().text !== ')') { - do { - argsFn.push(this.expression()); - } while (this.expect(',')); - } - this.consume(')'); - - var parser = this; - - return function(scope, locals) { - var args = []; - var context = contextGetter ? contextGetter(scope, locals) : scope; - - for (var i = 0; i < argsFn.length; i++) { - args.push(argsFn[i](scope, locals)); - } - var fnPtr = fn(scope, locals, context) || noop; - - ensureSafeObject(context, parser.text); - ensureSafeObject(fnPtr, parser.text); - - // IE stupidity! (IE doesn't have apply for some native functions) - var v = fnPtr.apply - ? fnPtr.apply(context, args) - : fnPtr(args[0], args[1], args[2], args[3], args[4]); - - return ensureSafeObject(v, parser.text); - }; - }, - - // This is used with json array declaration - arrayDeclaration: function () { - var elementFns = []; - var allConstant = true; - if (this.peekToken().text !== ']') { - do { - if (this.peek(']')) { - // Support trailing commas per ES5.1. - break; - } - var elementFn = this.expression(); - elementFns.push(elementFn); - if (!elementFn.constant) { - allConstant = false; - } - } while (this.expect(',')); - } - this.consume(']'); - - return extend(function(self, locals) { - var array = []; - for (var i = 0; i < elementFns.length; i++) { - array.push(elementFns[i](self, locals)); - } - return array; - }, { - literal: true, - constant: allConstant - }); - }, - - object: function () { - var keyValues = []; - var allConstant = true; - if (this.peekToken().text !== '}') { - do { - if (this.peek('}')) { - // Support trailing commas per ES5.1. - break; - } - var token = this.expect(), - key = token.string || token.text; - this.consume(':'); - var value = this.expression(); - keyValues.push({key: key, value: value}); - if (!value.constant) { - allConstant = false; - } - } while (this.expect(',')); - } - this.consume('}'); - - return extend(function(self, locals) { - var object = {}; - for (var i = 0; i < keyValues.length; i++) { - var keyValue = keyValues[i]; - object[keyValue.key] = keyValue.value(self, locals); - } - return object; - }, { - literal: true, - constant: allConstant - }); - } -}; - - -////////////////////////////////////////////////// -// Parser helper functions -////////////////////////////////////////////////// - -function setter(obj, path, setValue, fullExp, options) { - //needed? - options = options || {}; - - var element = path.split('.'), key; - for (var i = 0; element.length > 1; i++) { - key = ensureSafeMemberName(element.shift(), fullExp); - var propertyObj = obj[key]; - if (!propertyObj) { - propertyObj = {}; - obj[key] = propertyObj; - } - obj = propertyObj; - if (obj.then && options.unwrapPromises) { - promiseWarning(fullExp); - if (!("$$v" in obj)) { - (function(promise) { - promise.then(function(val) { promise.$$v = val; }); } - )(obj); - } - if (obj.$$v === undefined) { - obj.$$v = {}; - } - obj = obj.$$v; - } - } - key = ensureSafeMemberName(element.shift(), fullExp); - obj[key] = setValue; - return setValue; -} - -var getterFnCache = {}; - -/** - * Implementation of the "Black Hole" variant from: - * - http://jsperf.com/angularjs-parse-getter/4 - * - http://jsperf.com/path-evaluation-simplified/7 - */ -function cspSafeGetterFn(key0, key1, key2, key3, key4, fullExp, options) { - ensureSafeMemberName(key0, fullExp); - ensureSafeMemberName(key1, fullExp); - ensureSafeMemberName(key2, fullExp); - ensureSafeMemberName(key3, fullExp); - ensureSafeMemberName(key4, fullExp); - - return !options.unwrapPromises - ? function cspSafeGetter(scope, locals) { - var pathVal = (locals && locals.hasOwnProperty(key0)) ? locals : scope; - - if (pathVal == null) return pathVal; - pathVal = pathVal[key0]; - - if (!key1) return pathVal; - if (pathVal == null) return undefined; - pathVal = pathVal[key1]; - - if (!key2) return pathVal; - if (pathVal == null) return undefined; - pathVal = pathVal[key2]; - - if (!key3) return pathVal; - if (pathVal == null) return undefined; - pathVal = pathVal[key3]; - - if (!key4) return pathVal; - if (pathVal == null) return undefined; - pathVal = pathVal[key4]; - - return pathVal; - } - : function cspSafePromiseEnabledGetter(scope, locals) { - var pathVal = (locals && locals.hasOwnProperty(key0)) ? locals : scope, - promise; - - if (pathVal == null) return pathVal; - - pathVal = pathVal[key0]; - if (pathVal && pathVal.then) { - promiseWarning(fullExp); - if (!("$$v" in pathVal)) { - promise = pathVal; - promise.$$v = undefined; - promise.then(function(val) { promise.$$v = val; }); - } - pathVal = pathVal.$$v; - } - - if (!key1) return pathVal; - if (pathVal == null) return undefined; - pathVal = pathVal[key1]; - if (pathVal && pathVal.then) { - promiseWarning(fullExp); - if (!("$$v" in pathVal)) { - promise = pathVal; - promise.$$v = undefined; - promise.then(function(val) { promise.$$v = val; }); - } - pathVal = pathVal.$$v; - } - - if (!key2) return pathVal; - if (pathVal == null) return undefined; - pathVal = pathVal[key2]; - if (pathVal && pathVal.then) { - promiseWarning(fullExp); - if (!("$$v" in pathVal)) { - promise = pathVal; - promise.$$v = undefined; - promise.then(function(val) { promise.$$v = val; }); - } - pathVal = pathVal.$$v; - } - - if (!key3) return pathVal; - if (pathVal == null) return undefined; - pathVal = pathVal[key3]; - if (pathVal && pathVal.then) { - promiseWarning(fullExp); - if (!("$$v" in pathVal)) { - promise = pathVal; - promise.$$v = undefined; - promise.then(function(val) { promise.$$v = val; }); - } - pathVal = pathVal.$$v; - } - - if (!key4) return pathVal; - if (pathVal == null) return undefined; - pathVal = pathVal[key4]; - if (pathVal && pathVal.then) { - promiseWarning(fullExp); - if (!("$$v" in pathVal)) { - promise = pathVal; - promise.$$v = undefined; - promise.then(function(val) { promise.$$v = val; }); - } - pathVal = pathVal.$$v; - } - return pathVal; - }; -} - -function simpleGetterFn1(key0, fullExp) { - ensureSafeMemberName(key0, fullExp); - - return function simpleGetterFn1(scope, locals) { - if (scope == null) return undefined; - return ((locals && locals.hasOwnProperty(key0)) ? locals : scope)[key0]; - }; -} - -function simpleGetterFn2(key0, key1, fullExp) { - ensureSafeMemberName(key0, fullExp); - ensureSafeMemberName(key1, fullExp); - - return function simpleGetterFn2(scope, locals) { - if (scope == null) return undefined; - scope = ((locals && locals.hasOwnProperty(key0)) ? locals : scope)[key0]; - return scope == null ? undefined : scope[key1]; - }; -} - -function getterFn(path, options, fullExp) { - // Check whether the cache has this getter already. - // We can use hasOwnProperty directly on the cache because we ensure, - // see below, that the cache never stores a path called 'hasOwnProperty' - if (getterFnCache.hasOwnProperty(path)) { - return getterFnCache[path]; - } - - var pathKeys = path.split('.'), - pathKeysLength = pathKeys.length, - fn; - - // When we have only 1 or 2 tokens, use optimized special case closures. - // http://jsperf.com/angularjs-parse-getter/6 - if (!options.unwrapPromises && pathKeysLength === 1) { - fn = simpleGetterFn1(pathKeys[0], fullExp); - } else if (!options.unwrapPromises && pathKeysLength === 2) { - fn = simpleGetterFn2(pathKeys[0], pathKeys[1], fullExp); - } else if (options.csp) { - if (pathKeysLength < 6) { - fn = cspSafeGetterFn(pathKeys[0], pathKeys[1], pathKeys[2], pathKeys[3], pathKeys[4], fullExp, - options); - } else { - fn = function(scope, locals) { - var i = 0, val; - do { - val = cspSafeGetterFn(pathKeys[i++], pathKeys[i++], pathKeys[i++], pathKeys[i++], - pathKeys[i++], fullExp, options)(scope, locals); - - locals = undefined; // clear after first iteration - scope = val; - } while (i < pathKeysLength); - return val; - }; - } - } else { - var code = 'var p;\n'; - forEach(pathKeys, function(key, index) { - ensureSafeMemberName(key, fullExp); - code += 'if(s == null) return undefined;\n' + - 's='+ (index - // we simply dereference 's' on any .dot notation - ? 's' - // but if we are first then we check locals first, and if so read it first - : '((k&&k.hasOwnProperty("' + key + '"))?k:s)') + '["' + key + '"]' + ';\n' + - (options.unwrapPromises - ? 'if (s && s.then) {\n' + - ' pw("' + fullExp.replace(/(["\r\n])/g, '\\$1') + '");\n' + - ' if (!("$$v" in s)) {\n' + - ' p=s;\n' + - ' p.$$v = undefined;\n' + - ' p.then(function(v) {p.$$v=v;});\n' + - '}\n' + - ' s=s.$$v\n' + - '}\n' - : ''); - }); - code += 'return s;'; - - /* jshint -W054 */ - var evaledFnGetter = new Function('s', 'k', 'pw', code); // s=scope, k=locals, pw=promiseWarning - /* jshint +W054 */ - evaledFnGetter.toString = valueFn(code); - fn = options.unwrapPromises ? function(scope, locals) { - return evaledFnGetter(scope, locals, promiseWarning); - } : evaledFnGetter; - } - - // Only cache the value if it's not going to mess up the cache object - // This is more performant that using Object.prototype.hasOwnProperty.call - if (path !== 'hasOwnProperty') { - getterFnCache[path] = fn; - } - return fn; -} - -/////////////////////////////////// - -/** - * @ngdoc service - * @name $parse - * @kind function - * - * @description - * - * Converts Angular {@link guide/expression expression} into a function. - * - * ```js - * var getter = $parse('user.name'); - * var setter = getter.assign; - * var context = {user:{name:'angular'}}; - * var locals = {user:{name:'local'}}; - * - * expect(getter(context)).toEqual('angular'); - * setter(context, 'newValue'); - * expect(context.user.name).toEqual('newValue'); - * expect(getter(context, locals)).toEqual('local'); - * ``` - * - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - * - * The returned function also has the following properties: - * * `literal` – `{boolean}` – whether the expression's top-level node is a JavaScript - * literal. - * * `constant` – `{boolean}` – whether the expression is made entirely of JavaScript - * constant literals. - * * `assign` – `{?function(context, value)}` – if the expression is assignable, this will be - * set to a function to change its value on the given context. - * - */ - - -/** - * @ngdoc provider - * @name $parseProvider - * @function - * - * @description - * `$parseProvider` can be used for configuring the default behavior of the {@link ng.$parse $parse} - * service. - */ -function $ParseProvider() { - var cache = {}; - - var $parseOptions = { - csp: false, - unwrapPromises: false, - logPromiseWarnings: true - }; - - - /** - * @deprecated Promise unwrapping via $parse is deprecated and will be removed in the future. - * - * @ngdoc method - * @name $parseProvider#unwrapPromises - * @description - * - * **This feature is deprecated, see deprecation notes below for more info** - * - * If set to true (default is false), $parse will unwrap promises automatically when a promise is - * found at any part of the expression. In other words, if set to true, the expression will always - * result in a non-promise value. - * - * While the promise is unresolved, it's treated as undefined, but once resolved and fulfilled, - * the fulfillment value is used in place of the promise while evaluating the expression. - * - * **Deprecation notice** - * - * This is a feature that didn't prove to be wildly useful or popular, primarily because of the - * dichotomy between data access in templates (accessed as raw values) and controller code - * (accessed as promises). - * - * In most code we ended up resolving promises manually in controllers anyway and thus unifying - * the model access there. - * - * Other downsides of automatic promise unwrapping: - * - * - when building components it's often desirable to receive the raw promises - * - adds complexity and slows down expression evaluation - * - makes expression code pre-generation unattractive due to the amount of code that needs to be - * generated - * - makes IDE auto-completion and tool support hard - * - * **Warning Logs** - * - * If the unwrapping is enabled, Angular will log a warning about each expression that unwraps a - * promise (to reduce the noise, each expression is logged only once). To disable this logging use - * `$parseProvider.logPromiseWarnings(false)` api. - * - * - * @param {boolean=} value New value. - * @returns {boolean|self} Returns the current setting when used as getter and self if used as - * setter. - */ - this.unwrapPromises = function(value) { - if (isDefined(value)) { - $parseOptions.unwrapPromises = !!value; - return this; - } else { - return $parseOptions.unwrapPromises; - } - }; - - - /** - * @deprecated Promise unwrapping via $parse is deprecated and will be removed in the future. - * - * @ngdoc method - * @name $parseProvider#logPromiseWarnings - * @description - * - * Controls whether Angular should log a warning on any encounter of a promise in an expression. - * - * The default is set to `true`. - * - * This setting applies only if `$parseProvider.unwrapPromises` setting is set to true as well. - * - * @param {boolean=} value New value. - * @returns {boolean|self} Returns the current setting when used as getter and self if used as - * setter. - */ - this.logPromiseWarnings = function(value) { - if (isDefined(value)) { - $parseOptions.logPromiseWarnings = value; - return this; - } else { - return $parseOptions.logPromiseWarnings; - } - }; - - - this.$get = ['$filter', '$sniffer', '$log', function($filter, $sniffer, $log) { - $parseOptions.csp = $sniffer.csp; - - promiseWarning = function promiseWarningFn(fullExp) { - if (!$parseOptions.logPromiseWarnings || promiseWarningCache.hasOwnProperty(fullExp)) return; - promiseWarningCache[fullExp] = true; - $log.warn('[$parse] Promise found in the expression `' + fullExp + '`. ' + - 'Automatic unwrapping of promises in Angular expressions is deprecated.'); - }; - - return function(exp) { - var parsedExpression; - - switch (typeof exp) { - case 'string': - - if (cache.hasOwnProperty(exp)) { - return cache[exp]; - } - - var lexer = new Lexer($parseOptions); - var parser = new Parser(lexer, $filter, $parseOptions); - parsedExpression = parser.parse(exp, false); - - if (exp !== 'hasOwnProperty') { - // Only cache the value if it's not going to mess up the cache object - // This is more performant that using Object.prototype.hasOwnProperty.call - cache[exp] = parsedExpression; - } - - return parsedExpression; - - case 'function': - return exp; - - default: - return noop; - } - }; - }]; -} - -/** - * @ngdoc service - * @name $q - * @requires $rootScope - * - * @description - * A promise/deferred implementation inspired by [Kris Kowal's Q](https://github.com/kriskowal/q). - * - * [The CommonJS Promise proposal](http://wiki.commonjs.org/wiki/Promises) describes a promise as an - * interface for interacting with an object that represents the result of an action that is - * performed asynchronously, and may or may not be finished at any given point in time. - * - * From the perspective of dealing with error handling, deferred and promise APIs are to - * asynchronous programming what `try`, `catch` and `throw` keywords are to synchronous programming. - * - * ```js - * // for the purpose of this example let's assume that variables `$q`, `scope` and `okToGreet` - * // are available in the current lexical scope (they could have been injected or passed in). - * - * function asyncGreet(name) { - * var deferred = $q.defer(); - * - * setTimeout(function() { - * // since this fn executes async in a future turn of the event loop, we need to wrap - * // our code into an $apply call so that the model changes are properly observed. - * scope.$apply(function() { - * deferred.notify('About to greet ' + name + '.'); - * - * if (okToGreet(name)) { - * deferred.resolve('Hello, ' + name + '!'); - * } else { - * deferred.reject('Greeting ' + name + ' is not allowed.'); - * } - * }); - * }, 1000); - * - * return deferred.promise; - * } - * - * var promise = asyncGreet('Robin Hood'); - * promise.then(function(greeting) { - * alert('Success: ' + greeting); - * }, function(reason) { - * alert('Failed: ' + reason); - * }, function(update) { - * alert('Got notification: ' + update); - * }); - * ``` - * - * At first it might not be obvious why this extra complexity is worth the trouble. The payoff - * comes in the way of guarantees that promise and deferred APIs make, see - * https://github.com/kriskowal/uncommonjs/blob/master/promises/specification.md. - * - * Additionally the promise api allows for composition that is very hard to do with the - * traditional callback ([CPS](http://en.wikipedia.org/wiki/Continuation-passing_style)) approach. - * For more on this please see the [Q documentation](https://github.com/kriskowal/q) especially the - * section on serial or parallel joining of promises. - * - * - * # The Deferred API - * - * A new instance of deferred is constructed by calling `$q.defer()`. - * - * The purpose of the deferred object is to expose the associated Promise instance as well as APIs - * that can be used for signaling the successful or unsuccessful completion, as well as the status - * of the task. - * - * **Methods** - * - * - `resolve(value)` – resolves the derived promise with the `value`. If the value is a rejection - * constructed via `$q.reject`, the promise will be rejected instead. - * - `reject(reason)` – rejects the derived promise with the `reason`. This is equivalent to - * resolving it with a rejection constructed via `$q.reject`. - * - `notify(value)` - provides updates on the status of the promise's execution. This may be called - * multiple times before the promise is either resolved or rejected. - * - * **Properties** - * - * - promise – `{Promise}` – promise object associated with this deferred. - * - * - * # The Promise API - * - * A new promise instance is created when a deferred instance is created and can be retrieved by - * calling `deferred.promise`. - * - * The purpose of the promise object is to allow for interested parties to get access to the result - * of the deferred task when it completes. - * - * **Methods** - * - * - `then(successCallback, errorCallback, notifyCallback)` – regardless of when the promise was or - * will be resolved or rejected, `then` calls one of the success or error callbacks asynchronously - * as soon as the result is available. The callbacks are called with a single argument: the result - * or rejection reason. Additionally, the notify callback may be called zero or more times to - * provide a progress indication, before the promise is resolved or rejected. - * - * This method *returns a new promise* which is resolved or rejected via the return value of the - * `successCallback`, `errorCallback`. It also notifies via the return value of the - * `notifyCallback` method. The promise can not be resolved or rejected from the notifyCallback - * method. - * - * - `catch(errorCallback)` – shorthand for `promise.then(null, errorCallback)` - * - * - `finally(callback)` – allows you to observe either the fulfillment or rejection of a promise, - * but to do so without modifying the final value. This is useful to release resources or do some - * clean-up that needs to be done whether the promise was rejected or resolved. See the [full - * specification](https://github.com/kriskowal/q/wiki/API-Reference#promisefinallycallback) for - * more information. - * - * Because `finally` is a reserved word in JavaScript and reserved keywords are not supported as - * property names by ES3, you'll need to invoke the method like `promise['finally'](callback)` to - * make your code IE8 and Android 2.x compatible. - * - * # Chaining promises - * - * Because calling the `then` method of a promise returns a new derived promise, it is easily - * possible to create a chain of promises: - * - * ```js - * promiseB = promiseA.then(function(result) { - * return result + 1; - * }); - * - * // promiseB will be resolved immediately after promiseA is resolved and its value - * // will be the result of promiseA incremented by 1 - * ``` - * - * It is possible to create chains of any length and since a promise can be resolved with another - * promise (which will defer its resolution further), it is possible to pause/defer resolution of - * the promises at any point in the chain. This makes it possible to implement powerful APIs like - * $http's response interceptors. - * - * - * # Differences between Kris Kowal's Q and $q - * - * There are two main differences: - * - * - $q is integrated with the {@link ng.$rootScope.Scope} Scope model observation - * mechanism in angular, which means faster propagation of resolution or rejection into your - * models and avoiding unnecessary browser repaints, which would result in flickering UI. - * - Q has many more features than $q, but that comes at a cost of bytes. $q is tiny, but contains - * all the important functionality needed for common async tasks. - * - * # Testing - * - * ```js - * it('should simulate promise', inject(function($q, $rootScope) { - * var deferred = $q.defer(); - * var promise = deferred.promise; - * var resolvedValue; - * - * promise.then(function(value) { resolvedValue = value; }); - * expect(resolvedValue).toBeUndefined(); - * - * // Simulate resolving of promise - * deferred.resolve(123); - * // Note that the 'then' function does not get called synchronously. - * // This is because we want the promise API to always be async, whether or not - * // it got called synchronously or asynchronously. - * expect(resolvedValue).toBeUndefined(); - * - * // Propagate promise resolution to 'then' functions using $apply(). - * $rootScope.$apply(); - * expect(resolvedValue).toEqual(123); - * })); - * ``` - */ -function $QProvider() { - - this.$get = ['$rootScope', '$exceptionHandler', function($rootScope, $exceptionHandler) { - return qFactory(function(callback) { - $rootScope.$evalAsync(callback); - }, $exceptionHandler); - }]; -} - - -/** - * Constructs a promise manager. - * - * @param {function(Function)} nextTick Function for executing functions in the next turn. - * @param {function(...*)} exceptionHandler Function into which unexpected exceptions are passed for - * debugging purposes. - * @returns {object} Promise manager. - */ -function qFactory(nextTick, exceptionHandler) { - - /** - * @ngdoc method - * @name $q#defer - * @function - * - * @description - * Creates a `Deferred` object which represents a task which will finish in the future. - * - * @returns {Deferred} Returns a new instance of deferred. - */ - var defer = function() { - var pending = [], - value, deferred; - - deferred = { - - resolve: function(val) { - if (pending) { - var callbacks = pending; - pending = undefined; - value = ref(val); - - if (callbacks.length) { - nextTick(function() { - var callback; - for (var i = 0, ii = callbacks.length; i < ii; i++) { - callback = callbacks[i]; - value.then(callback[0], callback[1], callback[2]); - } - }); - } - } - }, - - - reject: function(reason) { - deferred.resolve(createInternalRejectedPromise(reason)); - }, - - - notify: function(progress) { - if (pending) { - var callbacks = pending; - - if (pending.length) { - nextTick(function() { - var callback; - for (var i = 0, ii = callbacks.length; i < ii; i++) { - callback = callbacks[i]; - callback[2](progress); - } - }); - } - } - }, - - - promise: { - then: function(callback, errback, progressback) { - var result = defer(); - - var wrappedCallback = function(value) { - try { - result.resolve((isFunction(callback) ? callback : defaultCallback)(value)); - } catch(e) { - result.reject(e); - exceptionHandler(e); - } - }; - - var wrappedErrback = function(reason) { - try { - result.resolve((isFunction(errback) ? errback : defaultErrback)(reason)); - } catch(e) { - result.reject(e); - exceptionHandler(e); - } - }; - - var wrappedProgressback = function(progress) { - try { - result.notify((isFunction(progressback) ? progressback : defaultCallback)(progress)); - } catch(e) { - exceptionHandler(e); - } - }; - - if (pending) { - pending.push([wrappedCallback, wrappedErrback, wrappedProgressback]); - } else { - value.then(wrappedCallback, wrappedErrback, wrappedProgressback); - } - - return result.promise; - }, - - "catch": function(callback) { - return this.then(null, callback); - }, - - "finally": function(callback) { - - function makePromise(value, resolved) { - var result = defer(); - if (resolved) { - result.resolve(value); - } else { - result.reject(value); - } - return result.promise; - } - - function handleCallback(value, isResolved) { - var callbackOutput = null; - try { - callbackOutput = (callback ||defaultCallback)(); - } catch(e) { - return makePromise(e, false); - } - if (callbackOutput && isFunction(callbackOutput.then)) { - return callbackOutput.then(function() { - return makePromise(value, isResolved); - }, function(error) { - return makePromise(error, false); - }); - } else { - return makePromise(value, isResolved); - } - } - - return this.then(function(value) { - return handleCallback(value, true); - }, function(error) { - return handleCallback(error, false); - }); - } - } - }; - - return deferred; - }; - - - var ref = function(value) { - if (value && isFunction(value.then)) return value; - return { - then: function(callback) { - var result = defer(); - nextTick(function() { - result.resolve(callback(value)); - }); - return result.promise; - } - }; - }; - - - /** - * @ngdoc method - * @name $q#reject - * @function - * - * @description - * Creates a promise that is resolved as rejected with the specified `reason`. This api should be - * used to forward rejection in a chain of promises. If you are dealing with the last promise in - * a promise chain, you don't need to worry about it. - * - * When comparing deferreds/promises to the familiar behavior of try/catch/throw, think of - * `reject` as the `throw` keyword in JavaScript. This also means that if you "catch" an error via - * a promise error callback and you want to forward the error to the promise derived from the - * current promise, you have to "rethrow" the error by returning a rejection constructed via - * `reject`. - * - * ```js - * promiseB = promiseA.then(function(result) { - * // success: do something and resolve promiseB - * // with the old or a new result - * return result; - * }, function(reason) { - * // error: handle the error if possible and - * // resolve promiseB with newPromiseOrValue, - * // otherwise forward the rejection to promiseB - * if (canHandle(reason)) { - * // handle the error and recover - * return newPromiseOrValue; - * } - * return $q.reject(reason); - * }); - * ``` - * - * @param {*} reason Constant, message, exception or an object representing the rejection reason. - * @returns {Promise} Returns a promise that was already resolved as rejected with the `reason`. - */ - var reject = function(reason) { - var result = defer(); - result.reject(reason); - return result.promise; - }; - - var createInternalRejectedPromise = function(reason) { - return { - then: function(callback, errback) { - var result = defer(); - nextTick(function() { - try { - result.resolve((isFunction(errback) ? errback : defaultErrback)(reason)); - } catch(e) { - result.reject(e); - exceptionHandler(e); - } - }); - return result.promise; - } - }; - }; - - - /** - * @ngdoc method - * @name $q#when - * @function - * - * @description - * Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise. - * This is useful when you are dealing with an object that might or might not be a promise, or if - * the promise comes from a source that can't be trusted. - * - * @param {*} value Value or a promise - * @returns {Promise} Returns a promise of the passed value or promise - */ - var when = function(value, callback, errback, progressback) { - var result = defer(), - done; - - var wrappedCallback = function(value) { - try { - return (isFunction(callback) ? callback : defaultCallback)(value); - } catch (e) { - exceptionHandler(e); - return reject(e); - } - }; - - var wrappedErrback = function(reason) { - try { - return (isFunction(errback) ? errback : defaultErrback)(reason); - } catch (e) { - exceptionHandler(e); - return reject(e); - } - }; - - var wrappedProgressback = function(progress) { - try { - return (isFunction(progressback) ? progressback : defaultCallback)(progress); - } catch (e) { - exceptionHandler(e); - } - }; - - nextTick(function() { - ref(value).then(function(value) { - if (done) return; - done = true; - result.resolve(ref(value).then(wrappedCallback, wrappedErrback, wrappedProgressback)); - }, function(reason) { - if (done) return; - done = true; - result.resolve(wrappedErrback(reason)); - }, function(progress) { - if (done) return; - result.notify(wrappedProgressback(progress)); - }); - }); - - return result.promise; - }; - - - function defaultCallback(value) { - return value; - } - - - function defaultErrback(reason) { - return reject(reason); - } - - - /** - * @ngdoc method - * @name $q#all - * @function - * - * @description - * Combines multiple promises into a single promise that is resolved when all of the input - * promises are resolved. - * - * @param {Array.|Object.} promises An array or hash of promises. - * @returns {Promise} Returns a single promise that will be resolved with an array/hash of values, - * each value corresponding to the promise at the same index/key in the `promises` array/hash. - * If any of the promises is resolved with a rejection, this resulting promise will be rejected - * with the same rejection value. - */ - function all(promises) { - var deferred = defer(), - counter = 0, - results = isArray(promises) ? [] : {}; - - forEach(promises, function(promise, key) { - counter++; - ref(promise).then(function(value) { - if (results.hasOwnProperty(key)) return; - results[key] = value; - if (!(--counter)) deferred.resolve(results); - }, function(reason) { - if (results.hasOwnProperty(key)) return; - deferred.reject(reason); - }); - }); - - if (counter === 0) { - deferred.resolve(results); - } - - return deferred.promise; - } - - return { - defer: defer, - reject: reject, - when: when, - all: all - }; -} - -function $$RAFProvider(){ //rAF - this.$get = ['$window', '$timeout', function($window, $timeout) { - var requestAnimationFrame = $window.requestAnimationFrame || - $window.webkitRequestAnimationFrame || - $window.mozRequestAnimationFrame; - - var cancelAnimationFrame = $window.cancelAnimationFrame || - $window.webkitCancelAnimationFrame || - $window.mozCancelAnimationFrame || - $window.webkitCancelRequestAnimationFrame; - - var rafSupported = !!requestAnimationFrame; - var raf = rafSupported - ? function(fn) { - var id = requestAnimationFrame(fn); - return function() { - cancelAnimationFrame(id); - }; - } - : function(fn) { - var timer = $timeout(fn, 16.66, false); // 1000 / 60 = 16.666 - return function() { - $timeout.cancel(timer); - }; - }; - - raf.supported = rafSupported; - - return raf; - }]; -} - -/** - * DESIGN NOTES - * - * The design decisions behind the scope are heavily favored for speed and memory consumption. - * - * The typical use of scope is to watch the expressions, which most of the time return the same - * value as last time so we optimize the operation. - * - * Closures construction is expensive in terms of speed as well as memory: - * - No closures, instead use prototypical inheritance for API - * - Internal state needs to be stored on scope directly, which means that private state is - * exposed as $$____ properties - * - * Loop operations are optimized by using while(count--) { ... } - * - this means that in order to keep the same order of execution as addition we have to add - * items to the array at the beginning (shift) instead of at the end (push) - * - * Child scopes are created and removed often - * - Using an array would be slow since inserts in middle are expensive so we use linked list - * - * There are few watches then a lot of observers. This is why you don't want the observer to be - * implemented in the same way as watch. Watch requires return of initialization function which - * are expensive to construct. - */ - - -/** - * @ngdoc provider - * @name $rootScopeProvider - * @description - * - * Provider for the $rootScope service. - */ - -/** - * @ngdoc method - * @name $rootScopeProvider#digestTtl - * @description - * - * Sets the number of `$digest` iterations the scope should attempt to execute before giving up and - * assuming that the model is unstable. - * - * The current default is 10 iterations. - * - * In complex applications it's possible that the dependencies between `$watch`s will result in - * several digest iterations. However if an application needs more than the default 10 digest - * iterations for its model to stabilize then you should investigate what is causing the model to - * continuously change during the digest. - * - * Increasing the TTL could have performance implications, so you should not change it without - * proper justification. - * - * @param {number} limit The number of digest iterations. - */ - - -/** - * @ngdoc service - * @name $rootScope - * @description - * - * Every application has a single root {@link ng.$rootScope.Scope scope}. - * All other scopes are descendant scopes of the root scope. Scopes provide separation - * between the model and the view, via a mechanism for watching the model for changes. - * They also provide an event emission/broadcast and subscription facility. See the - * {@link guide/scope developer guide on scopes}. - */ -function $RootScopeProvider(){ - var TTL = 10; - var $rootScopeMinErr = minErr('$rootScope'); - var lastDirtyWatch = null; - - this.digestTtl = function(value) { - if (arguments.length) { - TTL = value; - } - return TTL; - }; - - this.$get = ['$injector', '$exceptionHandler', '$parse', '$browser', - function( $injector, $exceptionHandler, $parse, $browser) { - - /** - * @ngdoc type - * @name $rootScope.Scope - * - * @description - * A root scope can be retrieved using the {@link ng.$rootScope $rootScope} key from the - * {@link auto.$injector $injector}. Child scopes are created using the - * {@link ng.$rootScope.Scope#$new $new()} method. (Most scopes are created automatically when - * compiled HTML template is executed.) - * - * Here is a simple scope snippet to show how you can interact with the scope. - * ```html - * - * ``` - * - * # Inheritance - * A scope can inherit from a parent scope, as in this example: - * ```js - var parent = $rootScope; - var child = parent.$new(); - - parent.salutation = "Hello"; - child.name = "World"; - expect(child.salutation).toEqual('Hello'); - - child.salutation = "Welcome"; - expect(child.salutation).toEqual('Welcome'); - expect(parent.salutation).toEqual('Hello'); - * ``` - * - * - * @param {Object.=} providers Map of service factory which need to be - * provided for the current scope. Defaults to {@link ng}. - * @param {Object.=} instanceCache Provides pre-instantiated services which should - * append/override services provided by `providers`. This is handy - * when unit-testing and having the need to override a default - * service. - * @returns {Object} Newly created scope. - * - */ - function Scope() { - this.$id = nextUid(); - this.$$phase = this.$parent = this.$$watchers = - this.$$nextSibling = this.$$prevSibling = - this.$$childHead = this.$$childTail = null; - this['this'] = this.$root = this; - this.$$destroyed = false; - this.$$asyncQueue = []; - this.$$postDigestQueue = []; - this.$$listeners = {}; - this.$$listenerCount = {}; - this.$$isolateBindings = {}; - } - - /** - * @ngdoc property - * @name $rootScope.Scope#$id - * @returns {number} Unique scope ID (monotonically increasing alphanumeric sequence) useful for - * debugging. - */ - - - Scope.prototype = { - constructor: Scope, - /** - * @ngdoc method - * @name $rootScope.Scope#$new - * @function - * - * @description - * Creates a new child {@link ng.$rootScope.Scope scope}. - * - * The parent scope will propagate the {@link ng.$rootScope.Scope#$digest $digest()} and - * {@link ng.$rootScope.Scope#$digest $digest()} events. The scope can be removed from the - * scope hierarchy using {@link ng.$rootScope.Scope#$destroy $destroy()}. - * - * {@link ng.$rootScope.Scope#$destroy $destroy()} must be called on a scope when it is - * desired for the scope and its child scopes to be permanently detached from the parent and - * thus stop participating in model change detection and listener notification by invoking. - * - * @param {boolean} isolate If true, then the scope does not prototypically inherit from the - * parent scope. The scope is isolated, as it can not see parent scope properties. - * When creating widgets, it is useful for the widget to not accidentally read parent - * state. - * - * @returns {Object} The newly created child scope. - * - */ - $new: function(isolate) { - var ChildScope, - child; - - if (isolate) { - child = new Scope(); - child.$root = this.$root; - // ensure that there is just one async queue per $rootScope and its children - child.$$asyncQueue = this.$$asyncQueue; - child.$$postDigestQueue = this.$$postDigestQueue; - } else { - ChildScope = function() {}; // should be anonymous; This is so that when the minifier munges - // the name it does not become random set of chars. This will then show up as class - // name in the web inspector. - ChildScope.prototype = this; - child = new ChildScope(); - child.$id = nextUid(); - } - child['this'] = child; - child.$$listeners = {}; - child.$$listenerCount = {}; - child.$parent = this; - child.$$watchers = child.$$nextSibling = child.$$childHead = child.$$childTail = null; - child.$$prevSibling = this.$$childTail; - if (this.$$childHead) { - this.$$childTail.$$nextSibling = child; - this.$$childTail = child; - } else { - this.$$childHead = this.$$childTail = child; - } - return child; - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$watch - * @function - * - * @description - * Registers a `listener` callback to be executed whenever the `watchExpression` changes. - * - * - The `watchExpression` is called on every call to {@link ng.$rootScope.Scope#$digest - * $digest()} and should return the value that will be watched. (Since - * {@link ng.$rootScope.Scope#$digest $digest()} reruns when it detects changes the - * `watchExpression` can execute multiple times per - * {@link ng.$rootScope.Scope#$digest $digest()} and should be idempotent.) - * - The `listener` is called only when the value from the current `watchExpression` and the - * previous call to `watchExpression` are not equal (with the exception of the initial run, - * see below). The inequality is determined according to - * {@link angular.equals} function. To save the value of the object for later comparison, - * the {@link angular.copy} function is used. It also means that watching complex options - * will have adverse memory and performance implications. - * - The watch `listener` may change the model, which may trigger other `listener`s to fire. - * This is achieved by rerunning the watchers until no changes are detected. The rerun - * iteration limit is 10 to prevent an infinite loop deadlock. - * - * - * If you want to be notified whenever {@link ng.$rootScope.Scope#$digest $digest} is called, - * you can register a `watchExpression` function with no `listener`. (Since `watchExpression` - * can execute multiple times per {@link ng.$rootScope.Scope#$digest $digest} cycle when a - * change is detected, be prepared for multiple calls to your listener.) - * - * After a watcher is registered with the scope, the `listener` fn is called asynchronously - * (via {@link ng.$rootScope.Scope#$evalAsync $evalAsync}) to initialize the - * watcher. In rare cases, this is undesirable because the listener is called when the result - * of `watchExpression` didn't change. To detect this scenario within the `listener` fn, you - * can compare the `newVal` and `oldVal`. If these two values are identical (`===`) then the - * listener was called due to initialization. - * - * The example below contains an illustration of using a function as your $watch listener - * - * - * # Example - * ```js - // let's assume that scope was dependency injected as the $rootScope - var scope = $rootScope; - scope.name = 'misko'; - scope.counter = 0; - - expect(scope.counter).toEqual(0); - scope.$watch('name', function(newValue, oldValue) { - scope.counter = scope.counter + 1; - }); - expect(scope.counter).toEqual(0); - - scope.$digest(); - // no variable change - expect(scope.counter).toEqual(0); - - scope.name = 'adam'; - scope.$digest(); - expect(scope.counter).toEqual(1); - - - - // Using a listener function - var food; - scope.foodCounter = 0; - expect(scope.foodCounter).toEqual(0); - scope.$watch( - // This is the listener function - function() { return food; }, - // This is the change handler - function(newValue, oldValue) { - if ( newValue !== oldValue ) { - // Only increment the counter if the value changed - scope.foodCounter = scope.foodCounter + 1; - } - } - ); - // No digest has been run so the counter will be zero - expect(scope.foodCounter).toEqual(0); - - // Run the digest but since food has not changed count will still be zero - scope.$digest(); - expect(scope.foodCounter).toEqual(0); - - // Update food and run digest. Now the counter will increment - food = 'cheeseburger'; - scope.$digest(); - expect(scope.foodCounter).toEqual(1); - - * ``` - * - * - * - * @param {(function()|string)} watchExpression Expression that is evaluated on each - * {@link ng.$rootScope.Scope#$digest $digest} cycle. A change in the return value triggers - * a call to the `listener`. - * - * - `string`: Evaluated as {@link guide/expression expression} - * - `function(scope)`: called with current `scope` as a parameter. - * @param {(function()|string)=} listener Callback called whenever the return value of - * the `watchExpression` changes. - * - * - `string`: Evaluated as {@link guide/expression expression} - * - `function(newValue, oldValue, scope)`: called with current and previous values as - * parameters. - * - * @param {boolean=} objectEquality Compare for object equality using {@link angular.equals} instead of - * comparing for reference equality. - * @returns {function()} Returns a deregistration function for this listener. - */ - $watch: function(watchExp, listener, objectEquality) { - var scope = this, - get = compileToFn(watchExp, 'watch'), - array = scope.$$watchers, - watcher = { - fn: listener, - last: initWatchVal, - get: get, - exp: watchExp, - eq: !!objectEquality - }; - - lastDirtyWatch = null; - - // in the case user pass string, we need to compile it, do we really need this ? - if (!isFunction(listener)) { - var listenFn = compileToFn(listener || noop, 'listener'); - watcher.fn = function(newVal, oldVal, scope) {listenFn(scope);}; - } - - if (typeof watchExp == 'string' && get.constant) { - var originalFn = watcher.fn; - watcher.fn = function(newVal, oldVal, scope) { - originalFn.call(this, newVal, oldVal, scope); - arrayRemove(array, watcher); - }; - } - - if (!array) { - array = scope.$$watchers = []; - } - // we use unshift since we use a while loop in $digest for speed. - // the while loop reads in reverse order. - array.unshift(watcher); - - return function() { - arrayRemove(array, watcher); - lastDirtyWatch = null; - }; - }, - - - /** - * @ngdoc method - * @name $rootScope.Scope#$watchCollection - * @function - * - * @description - * Shallow watches the properties of an object and fires whenever any of the properties change - * (for arrays, this implies watching the array items; for object maps, this implies watching - * the properties). If a change is detected, the `listener` callback is fired. - * - * - The `obj` collection is observed via standard $watch operation and is examined on every - * call to $digest() to see if any items have been added, removed, or moved. - * - The `listener` is called whenever anything within the `obj` has changed. Examples include - * adding, removing, and moving items belonging to an object or array. - * - * - * # Example - * ```js - $scope.names = ['igor', 'matias', 'misko', 'james']; - $scope.dataCount = 4; - - $scope.$watchCollection('names', function(newNames, oldNames) { - $scope.dataCount = newNames.length; - }); - - expect($scope.dataCount).toEqual(4); - $scope.$digest(); - - //still at 4 ... no changes - expect($scope.dataCount).toEqual(4); - - $scope.names.pop(); - $scope.$digest(); - - //now there's been a change - expect($scope.dataCount).toEqual(3); - * ``` - * - * - * @param {string|function(scope)} obj Evaluated as {@link guide/expression expression}. The - * expression value should evaluate to an object or an array which is observed on each - * {@link ng.$rootScope.Scope#$digest $digest} cycle. Any shallow change within the - * collection will trigger a call to the `listener`. - * - * @param {function(newCollection, oldCollection, scope)} listener a callback function called - * when a change is detected. - * - The `newCollection` object is the newly modified data obtained from the `obj` expression - * - The `oldCollection` object is a copy of the former collection data. - * Due to performance considerations, the`oldCollection` value is computed only if the - * `listener` function declares two or more arguments. - * - The `scope` argument refers to the current scope. - * - * @returns {function()} Returns a de-registration function for this listener. When the - * de-registration function is executed, the internal watch operation is terminated. - */ - $watchCollection: function(obj, listener) { - var self = this; - // the current value, updated on each dirty-check run - var newValue; - // a shallow copy of the newValue from the last dirty-check run, - // updated to match newValue during dirty-check run - var oldValue; - // a shallow copy of the newValue from when the last change happened - var veryOldValue; - // only track veryOldValue if the listener is asking for it - var trackVeryOldValue = (listener.length > 1); - var changeDetected = 0; - var objGetter = $parse(obj); - var internalArray = []; - var internalObject = {}; - var initRun = true; - var oldLength = 0; - - function $watchCollectionWatch() { - newValue = objGetter(self); - var newLength, key; - - if (!isObject(newValue)) { // if primitive - if (oldValue !== newValue) { - oldValue = newValue; - changeDetected++; - } - } else if (isArrayLike(newValue)) { - if (oldValue !== internalArray) { - // we are transitioning from something which was not an array into array. - oldValue = internalArray; - oldLength = oldValue.length = 0; - changeDetected++; - } - - newLength = newValue.length; - - if (oldLength !== newLength) { - // if lengths do not match we need to trigger change notification - changeDetected++; - oldValue.length = oldLength = newLength; - } - // copy the items to oldValue and look for changes. - for (var i = 0; i < newLength; i++) { - var bothNaN = (oldValue[i] !== oldValue[i]) && - (newValue[i] !== newValue[i]); - if (!bothNaN && (oldValue[i] !== newValue[i])) { - changeDetected++; - oldValue[i] = newValue[i]; - } - } - } else { - if (oldValue !== internalObject) { - // we are transitioning from something which was not an object into object. - oldValue = internalObject = {}; - oldLength = 0; - changeDetected++; - } - // copy the items to oldValue and look for changes. - newLength = 0; - for (key in newValue) { - if (newValue.hasOwnProperty(key)) { - newLength++; - if (oldValue.hasOwnProperty(key)) { - if (oldValue[key] !== newValue[key]) { - changeDetected++; - oldValue[key] = newValue[key]; - } - } else { - oldLength++; - oldValue[key] = newValue[key]; - changeDetected++; - } - } - } - if (oldLength > newLength) { - // we used to have more keys, need to find them and destroy them. - changeDetected++; - for(key in oldValue) { - if (oldValue.hasOwnProperty(key) && !newValue.hasOwnProperty(key)) { - oldLength--; - delete oldValue[key]; - } - } - } - } - return changeDetected; - } - - function $watchCollectionAction() { - if (initRun) { - initRun = false; - listener(newValue, newValue, self); - } else { - listener(newValue, veryOldValue, self); - } - - // make a copy for the next time a collection is changed - if (trackVeryOldValue) { - if (!isObject(newValue)) { - //primitive - veryOldValue = newValue; - } else if (isArrayLike(newValue)) { - veryOldValue = new Array(newValue.length); - for (var i = 0; i < newValue.length; i++) { - veryOldValue[i] = newValue[i]; - } - } else { // if object - veryOldValue = {}; - for (var key in newValue) { - if (hasOwnProperty.call(newValue, key)) { - veryOldValue[key] = newValue[key]; - } - } - } - } - } - - return this.$watch($watchCollectionWatch, $watchCollectionAction); - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$digest - * @function - * - * @description - * Processes all of the {@link ng.$rootScope.Scope#$watch watchers} of the current scope and - * its children. Because a {@link ng.$rootScope.Scope#$watch watcher}'s listener can change - * the model, the `$digest()` keeps calling the {@link ng.$rootScope.Scope#$watch watchers} - * until no more listeners are firing. This means that it is possible to get into an infinite - * loop. This function will throw `'Maximum iteration limit exceeded.'` if the number of - * iterations exceeds 10. - * - * Usually, you don't call `$digest()` directly in - * {@link ng.directive:ngController controllers} or in - * {@link ng.$compileProvider#directive directives}. - * Instead, you should call {@link ng.$rootScope.Scope#$apply $apply()} (typically from within - * a {@link ng.$compileProvider#directive directives}), which will force a `$digest()`. - * - * If you want to be notified whenever `$digest()` is called, - * you can register a `watchExpression` function with - * {@link ng.$rootScope.Scope#$watch $watch()} with no `listener`. - * - * In unit tests, you may need to call `$digest()` to simulate the scope life cycle. - * - * # Example - * ```js - var scope = ...; - scope.name = 'misko'; - scope.counter = 0; - - expect(scope.counter).toEqual(0); - scope.$watch('name', function(newValue, oldValue) { - scope.counter = scope.counter + 1; - }); - expect(scope.counter).toEqual(0); - - scope.$digest(); - // no variable change - expect(scope.counter).toEqual(0); - - scope.name = 'adam'; - scope.$digest(); - expect(scope.counter).toEqual(1); - * ``` - * - */ - $digest: function() { - var watch, value, last, - watchers, - asyncQueue = this.$$asyncQueue, - postDigestQueue = this.$$postDigestQueue, - length, - dirty, ttl = TTL, - next, current, target = this, - watchLog = [], - logIdx, logMsg, asyncTask; - - beginPhase('$digest'); - - lastDirtyWatch = null; - - do { // "while dirty" loop - dirty = false; - current = target; - - while(asyncQueue.length) { - try { - asyncTask = asyncQueue.shift(); - asyncTask.scope.$eval(asyncTask.expression); - } catch (e) { - clearPhase(); - $exceptionHandler(e); - } - lastDirtyWatch = null; - } - - traverseScopesLoop: - do { // "traverse the scopes" loop - if ((watchers = current.$$watchers)) { - // process our watches - length = watchers.length; - while (length--) { - try { - watch = watchers[length]; - // Most common watches are on primitives, in which case we can short - // circuit it with === operator, only when === fails do we use .equals - if (watch) { - if ((value = watch.get(current)) !== (last = watch.last) && - !(watch.eq - ? equals(value, last) - : (typeof value == 'number' && typeof last == 'number' - && isNaN(value) && isNaN(last)))) { - dirty = true; - lastDirtyWatch = watch; - watch.last = watch.eq ? copy(value) : value; - watch.fn(value, ((last === initWatchVal) ? value : last), current); - if (ttl < 5) { - logIdx = 4 - ttl; - if (!watchLog[logIdx]) watchLog[logIdx] = []; - logMsg = (isFunction(watch.exp)) - ? 'fn: ' + (watch.exp.name || watch.exp.toString()) - : watch.exp; - logMsg += '; newVal: ' + toJson(value) + '; oldVal: ' + toJson(last); - watchLog[logIdx].push(logMsg); - } - } else if (watch === lastDirtyWatch) { - // If the most recently dirty watcher is now clean, short circuit since the remaining watchers - // have already been tested. - dirty = false; - break traverseScopesLoop; - } - } - } catch (e) { - clearPhase(); - $exceptionHandler(e); - } - } - } - - // Insanity Warning: scope depth-first traversal - // yes, this code is a bit crazy, but it works and we have tests to prove it! - // this piece should be kept in sync with the traversal in $broadcast - if (!(next = (current.$$childHead || - (current !== target && current.$$nextSibling)))) { - while(current !== target && !(next = current.$$nextSibling)) { - current = current.$parent; - } - } - } while ((current = next)); - - // `break traverseScopesLoop;` takes us to here - - if((dirty || asyncQueue.length) && !(ttl--)) { - clearPhase(); - throw $rootScopeMinErr('infdig', - '{0} $digest() iterations reached. Aborting!\n' + - 'Watchers fired in the last 5 iterations: {1}', - TTL, toJson(watchLog)); - } - - } while (dirty || asyncQueue.length); - - clearPhase(); - - while(postDigestQueue.length) { - try { - postDigestQueue.shift()(); - } catch (e) { - $exceptionHandler(e); - } - } - }, - - - /** - * @ngdoc event - * @name $rootScope.Scope#$destroy - * @eventType broadcast on scope being destroyed - * - * @description - * Broadcasted when a scope and its children are being destroyed. - * - * Note that, in AngularJS, there is also a `$destroy` jQuery event, which can be used to - * clean up DOM bindings before an element is removed from the DOM. - */ - - /** - * @ngdoc method - * @name $rootScope.Scope#$destroy - * @function - * - * @description - * Removes the current scope (and all of its children) from the parent scope. Removal implies - * that calls to {@link ng.$rootScope.Scope#$digest $digest()} will no longer - * propagate to the current scope and its children. Removal also implies that the current - * scope is eligible for garbage collection. - * - * The `$destroy()` is usually used by directives such as - * {@link ng.directive:ngRepeat ngRepeat} for managing the - * unrolling of the loop. - * - * Just before a scope is destroyed, a `$destroy` event is broadcasted on this scope. - * Application code can register a `$destroy` event handler that will give it a chance to - * perform any necessary cleanup. - * - * Note that, in AngularJS, there is also a `$destroy` jQuery event, which can be used to - * clean up DOM bindings before an element is removed from the DOM. - */ - $destroy: function() { - // we can't destroy the root scope or a scope that has been already destroyed - if (this.$$destroyed) return; - var parent = this.$parent; - - this.$broadcast('$destroy'); - this.$$destroyed = true; - if (this === $rootScope) return; - - forEach(this.$$listenerCount, bind(null, decrementListenerCount, this)); - - // sever all the references to parent scopes (after this cleanup, the current scope should - // not be retained by any of our references and should be eligible for garbage collection) - if (parent.$$childHead == this) parent.$$childHead = this.$$nextSibling; - if (parent.$$childTail == this) parent.$$childTail = this.$$prevSibling; - if (this.$$prevSibling) this.$$prevSibling.$$nextSibling = this.$$nextSibling; - if (this.$$nextSibling) this.$$nextSibling.$$prevSibling = this.$$prevSibling; - - - // All of the code below is bogus code that works around V8's memory leak via optimized code - // and inline caches. - // - // see: - // - https://code.google.com/p/v8/issues/detail?id=2073#c26 - // - https://github.com/angular/angular.js/issues/6794#issuecomment-38648909 - // - https://github.com/angular/angular.js/issues/1313#issuecomment-10378451 - - this.$parent = this.$$nextSibling = this.$$prevSibling = this.$$childHead = - this.$$childTail = this.$root = null; - - // don't reset these to null in case some async task tries to register a listener/watch/task - this.$$listeners = {}; - this.$$watchers = this.$$asyncQueue = this.$$postDigestQueue = []; - - // prevent NPEs since these methods have references to properties we nulled out - this.$destroy = this.$digest = this.$apply = noop; - this.$on = this.$watch = function() { return noop; }; - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$eval - * @function - * - * @description - * Executes the `expression` on the current scope and returns the result. Any exceptions in - * the expression are propagated (uncaught). This is useful when evaluating Angular - * expressions. - * - * # Example - * ```js - var scope = ng.$rootScope.Scope(); - scope.a = 1; - scope.b = 2; - - expect(scope.$eval('a+b')).toEqual(3); - expect(scope.$eval(function(scope){ return scope.a + scope.b; })).toEqual(3); - * ``` - * - * @param {(string|function())=} expression An angular expression to be executed. - * - * - `string`: execute using the rules as defined in {@link guide/expression expression}. - * - `function(scope)`: execute the function with the current `scope` parameter. - * - * @param {(object)=} locals Local variables object, useful for overriding values in scope. - * @returns {*} The result of evaluating the expression. - */ - $eval: function(expr, locals) { - return $parse(expr)(this, locals); - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$evalAsync - * @function - * - * @description - * Executes the expression on the current scope at a later point in time. - * - * The `$evalAsync` makes no guarantees as to when the `expression` will be executed, only - * that: - * - * - it will execute after the function that scheduled the evaluation (preferably before DOM - * rendering). - * - at least one {@link ng.$rootScope.Scope#$digest $digest cycle} will be performed after - * `expression` execution. - * - * Any exceptions from the execution of the expression are forwarded to the - * {@link ng.$exceptionHandler $exceptionHandler} service. - * - * __Note:__ if this function is called outside of a `$digest` cycle, a new `$digest` cycle - * will be scheduled. However, it is encouraged to always call code that changes the model - * from within an `$apply` call. That includes code evaluated via `$evalAsync`. - * - * @param {(string|function())=} expression An angular expression to be executed. - * - * - `string`: execute using the rules as defined in {@link guide/expression expression}. - * - `function(scope)`: execute the function with the current `scope` parameter. - * - */ - $evalAsync: function(expr) { - // if we are outside of an $digest loop and this is the first time we are scheduling async - // task also schedule async auto-flush - if (!$rootScope.$$phase && !$rootScope.$$asyncQueue.length) { - $browser.defer(function() { - if ($rootScope.$$asyncQueue.length) { - $rootScope.$digest(); - } - }); - } - - this.$$asyncQueue.push({scope: this, expression: expr}); - }, - - $$postDigest : function(fn) { - this.$$postDigestQueue.push(fn); - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$apply - * @function - * - * @description - * `$apply()` is used to execute an expression in angular from outside of the angular - * framework. (For example from browser DOM events, setTimeout, XHR or third party libraries). - * Because we are calling into the angular framework we need to perform proper scope life - * cycle of {@link ng.$exceptionHandler exception handling}, - * {@link ng.$rootScope.Scope#$digest executing watches}. - * - * ## Life cycle - * - * # Pseudo-Code of `$apply()` - * ```js - function $apply(expr) { - try { - return $eval(expr); - } catch (e) { - $exceptionHandler(e); - } finally { - $root.$digest(); - } - } - * ``` - * - * - * Scope's `$apply()` method transitions through the following stages: - * - * 1. The {@link guide/expression expression} is executed using the - * {@link ng.$rootScope.Scope#$eval $eval()} method. - * 2. Any exceptions from the execution of the expression are forwarded to the - * {@link ng.$exceptionHandler $exceptionHandler} service. - * 3. The {@link ng.$rootScope.Scope#$watch watch} listeners are fired immediately after the - * expression was executed using the {@link ng.$rootScope.Scope#$digest $digest()} method. - * - * - * @param {(string|function())=} exp An angular expression to be executed. - * - * - `string`: execute using the rules as defined in {@link guide/expression expression}. - * - `function(scope)`: execute the function with current `scope` parameter. - * - * @returns {*} The result of evaluating the expression. - */ - $apply: function(expr) { - try { - beginPhase('$apply'); - return this.$eval(expr); - } catch (e) { - $exceptionHandler(e); - } finally { - clearPhase(); - try { - $rootScope.$digest(); - } catch (e) { - $exceptionHandler(e); - throw e; - } - } - }, - - /** - * @ngdoc method - * @name $rootScope.Scope#$on - * @function - * - * @description - * Listens on events of a given type. See {@link ng.$rootScope.Scope#$emit $emit} for - * discussion of event life cycle. - * - * The event listener function format is: `function(event, args...)`. The `event` object - * passed into the listener has the following attributes: - * - * - `targetScope` - `{Scope}`: the scope on which the event was `$emit`-ed or - * `$broadcast`-ed. - * - `currentScope` - `{Scope}`: the current scope which is handling the event. - * - `name` - `{string}`: name of the event. - * - `stopPropagation` - `{function=}`: calling `stopPropagation` function will cancel - * further event propagation (available only for events that were `$emit`-ed). - * - `preventDefault` - `{function}`: calling `preventDefault` sets `defaultPrevented` flag - * to true. - * - `defaultPrevented` - `{boolean}`: true if `preventDefault` was called. - * - * @param {string} name Event name to listen on. - * @param {function(event, ...args)} listener Function to call when the event is emitted. - * @returns {function()} Returns a deregistration function for this listener. - */ - $on: function(name, listener) { - var namedListeners = this.$$listeners[name]; - if (!namedListeners) { - this.$$listeners[name] = namedListeners = []; - } - namedListeners.push(listener); - - var current = this; - do { - if (!current.$$listenerCount[name]) { - current.$$listenerCount[name] = 0; - } - current.$$listenerCount[name]++; - } while ((current = current.$parent)); - - var self = this; - return function() { - namedListeners[indexOf(namedListeners, listener)] = null; - decrementListenerCount(self, 1, name); - }; - }, - - - /** - * @ngdoc method - * @name $rootScope.Scope#$emit - * @function - * - * @description - * Dispatches an event `name` upwards through the scope hierarchy notifying the - * registered {@link ng.$rootScope.Scope#$on} listeners. - * - * The event life cycle starts at the scope on which `$emit` was called. All - * {@link ng.$rootScope.Scope#$on listeners} listening for `name` event on this scope get - * notified. Afterwards, the event traverses upwards toward the root scope and calls all - * registered listeners along the way. The event will stop propagating if one of the listeners - * cancels it. - * - * Any exception emitted from the {@link ng.$rootScope.Scope#$on listeners} will be passed - * onto the {@link ng.$exceptionHandler $exceptionHandler} service. - * - * @param {string} name Event name to emit. - * @param {...*} args Optional one or more arguments which will be passed onto the event listeners. - * @return {Object} Event object (see {@link ng.$rootScope.Scope#$on}). - */ - $emit: function(name, args) { - var empty = [], - namedListeners, - scope = this, - stopPropagation = false, - event = { - name: name, - targetScope: scope, - stopPropagation: function() {stopPropagation = true;}, - preventDefault: function() { - event.defaultPrevented = true; - }, - defaultPrevented: false - }, - listenerArgs = concat([event], arguments, 1), - i, length; - - do { - namedListeners = scope.$$listeners[name] || empty; - event.currentScope = scope; - for (i=0, length=namedListeners.length; i= 8 ) { - normalizedVal = urlResolve(uri).href; - if (normalizedVal !== '' && !normalizedVal.match(regex)) { - return 'unsafe:'+normalizedVal; - } - } - return uri; - }; - }; -} - -var $sceMinErr = minErr('$sce'); - -var SCE_CONTEXTS = { - HTML: 'html', - CSS: 'css', - URL: 'url', - // RESOURCE_URL is a subtype of URL used in contexts where a privileged resource is sourced from a - // url. (e.g. ng-include, script src, templateUrl) - RESOURCE_URL: 'resourceUrl', - JS: 'js' -}; - -// Helper functions follow. - -// Copied from: -// http://docs.closure-library.googlecode.com/git/closure_goog_string_string.js.source.html#line962 -// Prereq: s is a string. -function escapeForRegexp(s) { - return s.replace(/([-()\[\]{}+?*.$\^|,:# -1) { - throw $sceMinErr('iwcard', - 'Illegal sequence *** in string matcher. String: {0}', matcher); - } - matcher = escapeForRegexp(matcher). - replace('\\*\\*', '.*'). - replace('\\*', '[^:/.?&;]*'); - return new RegExp('^' + matcher + '$'); - } else if (isRegExp(matcher)) { - // The only other type of matcher allowed is a Regexp. - // Match entire URL / disallow partial matches. - // Flags are reset (i.e. no global, ignoreCase or multiline) - return new RegExp('^' + matcher.source + '$'); - } else { - throw $sceMinErr('imatcher', - 'Matchers may only be "self", string patterns or RegExp objects'); - } -} - - -function adjustMatchers(matchers) { - var adjustedMatchers = []; - if (isDefined(matchers)) { - forEach(matchers, function(matcher) { - adjustedMatchers.push(adjustMatcher(matcher)); - }); - } - return adjustedMatchers; -} - - -/** - * @ngdoc service - * @name $sceDelegate - * @function - * - * @description - * - * `$sceDelegate` is a service that is used by the `$sce` service to provide {@link ng.$sce Strict - * Contextual Escaping (SCE)} services to AngularJS. - * - * Typically, you would configure or override the {@link ng.$sceDelegate $sceDelegate} instead of - * the `$sce` service to customize the way Strict Contextual Escaping works in AngularJS. This is - * because, while the `$sce` provides numerous shorthand methods, etc., you really only need to - * override 3 core functions (`trustAs`, `getTrusted` and `valueOf`) to replace the way things - * work because `$sce` delegates to `$sceDelegate` for these operations. - * - * Refer {@link ng.$sceDelegateProvider $sceDelegateProvider} to configure this service. - * - * The default instance of `$sceDelegate` should work out of the box with little pain. While you - * can override it completely to change the behavior of `$sce`, the common case would - * involve configuring the {@link ng.$sceDelegateProvider $sceDelegateProvider} instead by setting - * your own whitelists and blacklists for trusting URLs used for loading AngularJS resources such as - * templates. Refer {@link ng.$sceDelegateProvider#resourceUrlWhitelist - * $sceDelegateProvider.resourceUrlWhitelist} and {@link - * ng.$sceDelegateProvider#resourceUrlBlacklist $sceDelegateProvider.resourceUrlBlacklist} - */ - -/** - * @ngdoc provider - * @name $sceDelegateProvider - * @description - * - * The `$sceDelegateProvider` provider allows developers to configure the {@link ng.$sceDelegate - * $sceDelegate} service. This allows one to get/set the whitelists and blacklists used to ensure - * that the URLs used for sourcing Angular templates are safe. Refer {@link - * ng.$sceDelegateProvider#resourceUrlWhitelist $sceDelegateProvider.resourceUrlWhitelist} and - * {@link ng.$sceDelegateProvider#resourceUrlBlacklist $sceDelegateProvider.resourceUrlBlacklist} - * - * For the general details about this service in Angular, read the main page for {@link ng.$sce - * Strict Contextual Escaping (SCE)}. - * - * **Example**: Consider the following case. - * - * - your app is hosted at url `http://myapp.example.com/` - * - but some of your templates are hosted on other domains you control such as - * `http://srv01.assets.example.com/`,  `http://srv02.assets.example.com/`, etc. - * - and you have an open redirect at `http://myapp.example.com/clickThru?...`. - * - * Here is what a secure configuration for this scenario might look like: - * - * 
- *    angular.module('myApp', []).config(function($sceDelegateProvider) {
- *      $sceDelegateProvider.resourceUrlWhitelist([
- *        // Allow same origin resource loads.
- *        'self',
- *        // Allow loading from our assets domain.  Notice the difference between * and **.
- *        'http://srv*.assets.example.com/**']);
- *
- *      // The blacklist overrides the whitelist so the open redirect here is blocked.
- *      $sceDelegateProvider.resourceUrlBlacklist([
- *        'http://myapp.example.com/clickThru**']);
- *      });
- *
- */ - -function $SceDelegateProvider() { - this.SCE_CONTEXTS = SCE_CONTEXTS; - - // Resource URLs can also be trusted by policy. - var resourceUrlWhitelist = ['self'], - resourceUrlBlacklist = []; - - /** - * @ngdoc method - * @name $sceDelegateProvider#resourceUrlWhitelist - * @function - * - * @param {Array=} whitelist When provided, replaces the resourceUrlWhitelist with the value - * provided. This must be an array or null. A snapshot of this array is used so further - * changes to the array are ignored. - * - * Follow {@link ng.$sce#resourceUrlPatternItem this link} for a description of the items - * allowed in this array. - * - * Note: **an empty whitelist array will block all URLs**! - * - * @return {Array} the currently set whitelist array. - * - * The **default value** when no whitelist has been explicitly set is `['self']` allowing only - * same origin resource requests. - * - * @description - * Sets/Gets the whitelist of trusted resource URLs. - */ - this.resourceUrlWhitelist = function (value) { - if (arguments.length) { - resourceUrlWhitelist = adjustMatchers(value); - } - return resourceUrlWhitelist; - }; - - /** - * @ngdoc method - * @name $sceDelegateProvider#resourceUrlBlacklist - * @function - * - * @param {Array=} blacklist When provided, replaces the resourceUrlBlacklist with the value - * provided. This must be an array or null. A snapshot of this array is used so further - * changes to the array are ignored. - * - * Follow {@link ng.$sce#resourceUrlPatternItem this link} for a description of the items - * allowed in this array. - * - * The typical usage for the blacklist is to **block - * [open redirects](http://cwe.mitre.org/data/definitions/601.html)** served by your domain as - * these would otherwise be trusted but actually return content from the redirected domain. - * - * Finally, **the blacklist overrides the whitelist** and has the final say. - * - * @return {Array} the currently set blacklist array. - * - * The **default value** when no whitelist has been explicitly set is the empty array (i.e. there - * is no blacklist.) - * - * @description - * Sets/Gets the blacklist of trusted resource URLs. - */ - - this.resourceUrlBlacklist = function (value) { - if (arguments.length) { - resourceUrlBlacklist = adjustMatchers(value); - } - return resourceUrlBlacklist; - }; - - this.$get = ['$injector', function($injector) { - - var htmlSanitizer = function htmlSanitizer(html) { - throw $sceMinErr('unsafe', 'Attempting to use an unsafe value in a safe context.'); - }; - - if ($injector.has('$sanitize')) { - htmlSanitizer = $injector.get('$sanitize'); - } - - - function matchUrl(matcher, parsedUrl) { - if (matcher === 'self') { - return urlIsSameOrigin(parsedUrl); - } else { - // definitely a regex. See adjustMatchers() - return !!matcher.exec(parsedUrl.href); - } - } - - function isResourceUrlAllowedByPolicy(url) { - var parsedUrl = urlResolve(url.toString()); - var i, n, allowed = false; - // Ensure that at least one item from the whitelist allows this url. - for (i = 0, n = resourceUrlWhitelist.length; i < n; i++) { - if (matchUrl(resourceUrlWhitelist[i], parsedUrl)) { - allowed = true; - break; - } - } - if (allowed) { - // Ensure that no item from the blacklist blocked this url. - for (i = 0, n = resourceUrlBlacklist.length; i < n; i++) { - if (matchUrl(resourceUrlBlacklist[i], parsedUrl)) { - allowed = false; - break; - } - } - } - return allowed; - } - - function generateHolderType(Base) { - var holderType = function TrustedValueHolderType(trustedValue) { - this.$$unwrapTrustedValue = function() { - return trustedValue; - }; - }; - if (Base) { - holderType.prototype = new Base(); - } - holderType.prototype.valueOf = function sceValueOf() { - return this.$$unwrapTrustedValue(); - }; - holderType.prototype.toString = function sceToString() { - return this.$$unwrapTrustedValue().toString(); - }; - return holderType; - } - - var trustedValueHolderBase = generateHolderType(), - byType = {}; - - byType[SCE_CONTEXTS.HTML] = generateHolderType(trustedValueHolderBase); - byType[SCE_CONTEXTS.CSS] = generateHolderType(trustedValueHolderBase); - byType[SCE_CONTEXTS.URL] = generateHolderType(trustedValueHolderBase); - byType[SCE_CONTEXTS.JS] = generateHolderType(trustedValueHolderBase); - byType[SCE_CONTEXTS.RESOURCE_URL] = generateHolderType(byType[SCE_CONTEXTS.URL]); - - /** - * @ngdoc method - * @name $sceDelegate#trustAs - * - * @description - * Returns an object that is trusted by angular for use in specified strict - * contextual escaping contexts (such as ng-bind-html, ng-include, any src - * attribute interpolation, any dom event binding attribute interpolation - * such as for onclick, etc.) that uses the provided value. - * See {@link ng.$sce $sce} for enabling strict contextual escaping. - * - * @param {string} type The kind of context in which this value is safe for use. e.g. url, - * resourceUrl, html, js and css. - * @param {*} value The value that that should be considered trusted/safe. - * @returns {*} A value that can be used to stand in for the provided `value` in places - * where Angular expects a $sce.trustAs() return value. - */ - function trustAs(type, trustedValue) { - var Constructor = (byType.hasOwnProperty(type) ? byType[type] : null); - if (!Constructor) { - throw $sceMinErr('icontext', - 'Attempted to trust a value in invalid context. Context: {0}; Value: {1}', - type, trustedValue); - } - if (trustedValue === null || trustedValue === undefined || trustedValue === '') { - return trustedValue; - } - // All the current contexts in SCE_CONTEXTS happen to be strings. In order to avoid trusting - // mutable objects, we ensure here that the value passed in is actually a string. - if (typeof trustedValue !== 'string') { - throw $sceMinErr('itype', - 'Attempted to trust a non-string value in a content requiring a string: Context: {0}', - type); - } - return new Constructor(trustedValue); - } - - /** - * @ngdoc method - * @name $sceDelegate#valueOf - * - * @description - * If the passed parameter had been returned by a prior call to {@link ng.$sceDelegate#trustAs - * `$sceDelegate.trustAs`}, returns the value that had been passed to {@link - * ng.$sceDelegate#trustAs `$sceDelegate.trustAs`}. - * - * If the passed parameter is not a value that had been returned by {@link - * ng.$sceDelegate#trustAs `$sceDelegate.trustAs`}, returns it as-is. - * - * @param {*} value The result of a prior {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs`} - * call or anything else. - * @returns {*} The `value` that was originally provided to {@link ng.$sceDelegate#trustAs - * `$sceDelegate.trustAs`} if `value` is the result of such a call. Otherwise, returns - * `value` unchanged. - */ - function valueOf(maybeTrusted) { - if (maybeTrusted instanceof trustedValueHolderBase) { - return maybeTrusted.$$unwrapTrustedValue(); - } else { - return maybeTrusted; - } - } - - /** - * @ngdoc method - * @name $sceDelegate#getTrusted - * - * @description - * Takes the result of a {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs`} call and - * returns the originally supplied value if the queried context type is a supertype of the - * created type. If this condition isn't satisfied, throws an exception. - * - * @param {string} type The kind of context in which this value is to be used. - * @param {*} maybeTrusted The result of a prior {@link ng.$sceDelegate#trustAs - * `$sceDelegate.trustAs`} call. - * @returns {*} The value the was originally provided to {@link ng.$sceDelegate#trustAs - * `$sceDelegate.trustAs`} if valid in this context. Otherwise, throws an exception. - */ - function getTrusted(type, maybeTrusted) { - if (maybeTrusted === null || maybeTrusted === undefined || maybeTrusted === '') { - return maybeTrusted; - } - var constructor = (byType.hasOwnProperty(type) ? byType[type] : null); - if (constructor && maybeTrusted instanceof constructor) { - return maybeTrusted.$$unwrapTrustedValue(); - } - // If we get here, then we may only take one of two actions. - // 1. sanitize the value for the requested type, or - // 2. throw an exception. - if (type === SCE_CONTEXTS.RESOURCE_URL) { - if (isResourceUrlAllowedByPolicy(maybeTrusted)) { - return maybeTrusted; - } else { - throw $sceMinErr('insecurl', - 'Blocked loading resource from url not allowed by $sceDelegate policy. URL: {0}', - maybeTrusted.toString()); - } - } else if (type === SCE_CONTEXTS.HTML) { - return htmlSanitizer(maybeTrusted); - } - throw $sceMinErr('unsafe', 'Attempting to use an unsafe value in a safe context.'); - } - - return { trustAs: trustAs, - getTrusted: getTrusted, - valueOf: valueOf }; - }]; -} - - -/** - * @ngdoc provider - * @name $sceProvider - * @description - * - * The $sceProvider provider allows developers to configure the {@link ng.$sce $sce} service. - * - enable/disable Strict Contextual Escaping (SCE) in a module - * - override the default implementation with a custom delegate - * - * Read more about {@link ng.$sce Strict Contextual Escaping (SCE)}. - */ - -/* jshint maxlen: false*/ - -/** - * @ngdoc service - * @name $sce - * @function - * - * @description - * - * `$sce` is a service that provides Strict Contextual Escaping services to AngularJS. - * - * # Strict Contextual Escaping - * - * Strict Contextual Escaping (SCE) is a mode in which AngularJS requires bindings in certain - * contexts to result in a value that is marked as safe to use for that context. One example of - * such a context is binding arbitrary html controlled by the user via `ng-bind-html`. We refer - * to these contexts as privileged or SCE contexts. - * - * As of version 1.2, Angular ships with SCE enabled by default. - * - * Note: When enabled (the default), IE8 in quirks mode is not supported. In this mode, IE8 allows - * one to execute arbitrary javascript by the use of the expression() syntax. Refer - * to learn more about them. - * You can ensure your document is in standards mode and not quirks mode by adding `` - * to the top of your HTML document. - * - * SCE assists in writing code in way that (a) is secure by default and (b) makes auditing for - * security vulnerabilities such as XSS, clickjacking, etc. a lot easier. - * - * Here's an example of a binding in a privileged context: - * - * 
- *     
- *     

- *
- * - * Notice that `ng-bind-html` is bound to `userHtml` controlled by the user. With SCE - * disabled, this application allows the user to render arbitrary HTML into the DIV. - * In a more realistic example, one may be rendering user comments, blog articles, etc. via - * bindings. (HTML is just one example of a context where rendering user controlled input creates - * security vulnerabilities.) - * - * For the case of HTML, you might use a library, either on the client side, or on the server side, - * to sanitize unsafe HTML before binding to the value and rendering it in the document. - * - * How would you ensure that every place that used these types of bindings was bound to a value that - * was sanitized by your library (or returned as safe for rendering by your server?) How can you - * ensure that you didn't accidentally delete the line that sanitized the value, or renamed some - * properties/fields and forgot to update the binding to the sanitized value? - * - * To be secure by default, you want to ensure that any such bindings are disallowed unless you can - * determine that something explicitly says it's safe to use a value for binding in that - * context. You can then audit your code (a simple grep would do) to ensure that this is only done - * for those values that you can easily tell are safe - because they were received from your server, - * sanitized by your library, etc. You can organize your codebase to help with this - perhaps - * allowing only the files in a specific directory to do this. Ensuring that the internal API - * exposed by that code doesn't markup arbitrary values as safe then becomes a more manageable task. - * - * In the case of AngularJS' SCE service, one uses {@link ng.$sce#trustAs $sce.trustAs} - * (and shorthand methods such as {@link ng.$sce#trustAsHtml $sce.trustAsHtml}, etc.) to - * obtain values that will be accepted by SCE / privileged contexts. - * - * - * ## How does it work? - * - * In privileged contexts, directives and code will bind to the result of {@link ng.$sce#getTrusted - * $sce.getTrusted(context, value)} rather than to the value directly. Directives use {@link - * ng.$sce#parse $sce.parseAs} rather than `$parse` to watch attribute bindings, which performs the - * {@link ng.$sce#getTrusted $sce.getTrusted} behind the scenes on non-constant literals. - * - * As an example, {@link ng.directive:ngBindHtml ngBindHtml} uses {@link - * ng.$sce#parseAsHtml $sce.parseAsHtml(binding expression)}. Here's the actual code (slightly - * simplified): - * - * 
- *   var ngBindHtmlDirective = ['$sce', function($sce) {
- *     return function(scope, element, attr) {
- *       scope.$watch($sce.parseAsHtml(attr.ngBindHtml), function(value) {
- *         element.html(value || '');
- *       });
- *     };
- *   }];
- *
- * - * ## Impact on loading templates - * - * This applies both to the {@link ng.directive:ngInclude `ng-include`} directive as well as - * `templateUrl`'s specified by {@link guide/directive directives}. - * - * By default, Angular only loads templates from the same domain and protocol as the application - * document. This is done by calling {@link ng.$sce#getTrustedResourceUrl - * $sce.getTrustedResourceUrl} on the template URL. To load templates from other domains and/or - * protocols, you may either either {@link ng.$sceDelegateProvider#resourceUrlWhitelist whitelist - * them} or {@link ng.$sce#trustAsResourceUrl wrap it} into a trusted value. - * - * *Please note*: - * The browser's - * [Same Origin Policy](https://code.google.com/p/browsersec/wiki/Part2#Same-origin_policy_for_XMLHttpRequest) - * and [Cross-Origin Resource Sharing (CORS)](http://www.w3.org/TR/cors/) - * policy apply in addition to this and may further restrict whether the template is successfully - * loaded. This means that without the right CORS policy, loading templates from a different domain - * won't work on all browsers. Also, loading templates from `file://` URL does not work on some - * browsers. - * - * ## This feels like too much overhead for the developer? - * - * It's important to remember that SCE only applies to interpolation expressions. - * - * If your expressions are constant literals, they're automatically trusted and you don't need to - * call `$sce.trustAs` on them (remember to include the `ngSanitize` module) (e.g. - * `
`) just works. - * - * Additionally, `a[href]` and `img[src]` automatically sanitize their URLs and do not pass them - * through {@link ng.$sce#getTrusted $sce.getTrusted}. SCE doesn't play a role here. - * - * The included {@link ng.$sceDelegate $sceDelegate} comes with sane defaults to allow you to load - * templates in `ng-include` from your application's domain without having to even know about SCE. - * It blocks loading templates from other domains or loading templates over http from an https - * served document. You can change these by setting your own custom {@link - * ng.$sceDelegateProvider#resourceUrlWhitelist whitelists} and {@link - * ng.$sceDelegateProvider#resourceUrlBlacklist blacklists} for matching such URLs. - * - * This significantly reduces the overhead. It is far easier to pay the small overhead and have an - * application that's secure and can be audited to verify that with much more ease than bolting - * security onto an application later. - * - * - * ## What trusted context types are supported? - * - * | Context | Notes | - * |---------------------|----------------| - * | `$sce.HTML` | For HTML that's safe to source into the application. The {@link ng.directive:ngBindHtml ngBindHtml} directive uses this context for bindings. | - * | `$sce.CSS` | For CSS that's safe to source into the application. Currently unused. Feel free to use it in your own directives. | - * | `$sce.URL` | For URLs that are safe to follow as links. Currently unused (`
Note that `$sce.RESOURCE_URL` makes a stronger statement about the URL than `$sce.URL` does and therefore contexts requiring values trusted for `$sce.RESOURCE_URL` can be used anywhere that values trusted for `$sce.URL` are required. | - * | `$sce.JS` | For JavaScript that is safe to execute in your application's context. Currently unused. Feel free to use it in your own directives. | - * - * ## Format of items in {@link ng.$sceDelegateProvider#resourceUrlWhitelist resourceUrlWhitelist}/{@link ng.$sceDelegateProvider#resourceUrlBlacklist Blacklist} - * - * Each element in these arrays must be one of the following: - * - * - **'self'** - * - The special **string**, `'self'`, can be used to match against all URLs of the **same - * domain** as the application document using the **same protocol**. - * - **String** (except the special value `'self'`) - * - The string is matched against the full *normalized / absolute URL* of the resource - * being tested (substring matches are not good enough.) - * - There are exactly **two wildcard sequences** - `*` and `**`. All other characters - * match themselves. - * - `*`: matches zero or more occurrences of any character other than one of the following 6 - * characters: '`:`', '`/`', '`.`', '`?`', '`&`' and ';'. It's a useful wildcard for use - * in a whitelist. - * - `**`: matches zero or more occurrences of *any* character. As such, it's not - * not appropriate to use in for a scheme, domain, etc. as it would match too much. (e.g. - * http://**.example.com/ would match http://evil.com/?ignore=.example.com/ and that might - * not have been the intention.) It's usage at the very end of the path is ok. (e.g. - * http://foo.example.com/templates/**). - * - **RegExp** (*see caveat below*) - * - *Caveat*: While regular expressions are powerful and offer great flexibility, their syntax - * (and all the inevitable escaping) makes them *harder to maintain*. It's easy to - * accidentally introduce a bug when one updates a complex expression (imho, all regexes should - * have good test coverage.). For instance, the use of `.` in the regex is correct only in a - * small number of cases. A `.` character in the regex used when matching the scheme or a - * subdomain could be matched against a `:` or literal `.` that was likely not intended. It - * is highly recommended to use the string patterns and only fall back to regular expressions - * if they as a last resort. - * - The regular expression must be an instance of RegExp (i.e. not a string.) It is - * matched against the **entire** *normalized / absolute URL* of the resource being tested - * (even when the RegExp did not have the `^` and `$` codes.) In addition, any flags - * present on the RegExp (such as multiline, global, ignoreCase) are ignored. - * - If you are generating your JavaScript from some other templating engine (not - * recommended, e.g. in issue [#4006](https://github.com/angular/angular.js/issues/4006)), - * remember to escape your regular expression (and be aware that you might need more than - * one level of escaping depending on your templating engine and the way you interpolated - * the value.) Do make use of your platform's escaping mechanism as it might be good - * enough before coding your own. e.g. Ruby has - * [Regexp.escape(str)](http://www.ruby-doc.org/core-2.0.0/Regexp.html#method-c-escape) - * and Python has [re.escape](http://docs.python.org/library/re.html#re.escape). - * Javascript lacks a similar built in function for escaping. Take a look at Google - * Closure library's [goog.string.regExpEscape(s)]( - * http://docs.closure-library.googlecode.com/git/closure_goog_string_string.js.source.html#line962). - * - * Refer {@link ng.$sceDelegateProvider $sceDelegateProvider} for an example. - * - * ## Show me an example using SCE. - * - * @example - - -
-

- User comments
- By default, HTML that isn't explicitly trusted (e.g. Alice's comment) is sanitized when - $sanitize is available. If $sanitize isn't available, this results in an error instead of an - exploit. -
-
- {{userComment.name}}: - -
-
-
-
- - - - var mySceApp = angular.module('mySceApp', ['ngSanitize']); - - mySceApp.controller("myAppController", function myAppController($http, $templateCache, $sce) { - var self = this; - $http.get("test_data.json", {cache: $templateCache}).success(function(userComments) { - self.userComments = userComments; - }); - self.explicitlyTrustedHtml = $sce.trustAsHtml( - 'Hover over this text.'); - }); - - - -[ - { "name": "Alice", - "htmlComment": - "Is anyone reading this?" - }, - { "name": "Bob", - "htmlComment": "Yes! Am I the only other one?" - } -] - - - - describe('SCE doc demo', function() { - it('should sanitize untrusted values', function() { - expect(element(by.css('.htmlComment')).getInnerHtml()) - .toBe('Is anyone reading this?'); - }); - - it('should NOT sanitize explicitly trusted values', function() { - expect(element(by.id('explicitlyTrustedHtml')).getInnerHtml()).toBe( - 'Hover over this text.'); - }); - }); - - - * - * - * - * ## Can I disable SCE completely? - * - * Yes, you can. However, this is strongly discouraged. SCE gives you a lot of security benefits - * for little coding overhead. It will be much harder to take an SCE disabled application and - * either secure it on your own or enable SCE at a later stage. It might make sense to disable SCE - * for cases where you have a lot of existing code that was written before SCE was introduced and - * you're migrating them a module at a time. - * - * That said, here's how you can completely disable SCE: - * - * 
- *   angular.module('myAppWithSceDisabledmyApp', []).config(function($sceProvider) {
- *     // Completely disable SCE.  For demonstration purposes only!
- *     // Do not use in new projects.
- *     $sceProvider.enabled(false);
- *   });
- *
- * - */ -/* jshint maxlen: 100 */ - -function $SceProvider() { - var enabled = true; - - /** - * @ngdoc method - * @name $sceProvider#enabled - * @function - * - * @param {boolean=} value If provided, then enables/disables SCE. - * @return {boolean} true if SCE is enabled, false otherwise. - * - * @description - * Enables/disables SCE and returns the current value. - */ - this.enabled = function (value) { - if (arguments.length) { - enabled = !!value; - } - return enabled; - }; - - - /* Design notes on the default implementation for SCE. - * - * The API contract for the SCE delegate - * ------------------------------------- - * The SCE delegate object must provide the following 3 methods: - * - * - trustAs(contextEnum, value) - * This method is used to tell the SCE service that the provided value is OK to use in the - * contexts specified by contextEnum. It must return an object that will be accepted by - * getTrusted() for a compatible contextEnum and return this value. - * - * - valueOf(value) - * For values that were not produced by trustAs(), return them as is. For values that were - * produced by trustAs(), return the corresponding input value to trustAs. Basically, if - * trustAs is wrapping the given values into some type, this operation unwraps it when given - * such a value. - * - * - getTrusted(contextEnum, value) - * This function should return the a value that is safe to use in the context specified by - * contextEnum or throw and exception otherwise. - * - * NOTE: This contract deliberately does NOT state that values returned by trustAs() must be - * opaque or wrapped in some holder object. That happens to be an implementation detail. For - * instance, an implementation could maintain a registry of all trusted objects by context. In - * such a case, trustAs() would return the same object that was passed in. getTrusted() would - * return the same object passed in if it was found in the registry under a compatible context or - * throw an exception otherwise. An implementation might only wrap values some of the time based - * on some criteria. getTrusted() might return a value and not throw an exception for special - * constants or objects even if not wrapped. All such implementations fulfill this contract. - * - * - * A note on the inheritance model for SCE contexts - * ------------------------------------------------ - * I've used inheritance and made RESOURCE_URL wrapped types a subtype of URL wrapped types. This - * is purely an implementation details. - * - * The contract is simply this: - * - * getTrusted($sce.RESOURCE_URL, value) succeeding implies that getTrusted($sce.URL, value) - * will also succeed. - * - * Inheritance happens to capture this in a natural way. In some future, we - * may not use inheritance anymore. That is OK because no code outside of - * sce.js and sceSpecs.js would need to be aware of this detail. - */ - - this.$get = ['$parse', '$sniffer', '$sceDelegate', function( - $parse, $sniffer, $sceDelegate) { - // Prereq: Ensure that we're not running in IE8 quirks mode. In that mode, IE allows - // the "expression(javascript expression)" syntax which is insecure. - if (enabled && $sniffer.msie && $sniffer.msieDocumentMode < 8) { - throw $sceMinErr('iequirks', - 'Strict Contextual Escaping does not support Internet Explorer version < 9 in quirks ' + - 'mode. You can fix this by adding the text to the top of your HTML ' + - 'document. See http://docs.angularjs.org/api/ng.$sce for more information.'); - } - - var sce = copy(SCE_CONTEXTS); - - /** - * @ngdoc method - * @name $sce#isEnabled - * @function - * - * @return {Boolean} true if SCE is enabled, false otherwise. If you want to set the value, you - * have to do it at module config time on {@link ng.$sceProvider $sceProvider}. - * - * @description - * Returns a boolean indicating if SCE is enabled. - */ - sce.isEnabled = function () { - return enabled; - }; - sce.trustAs = $sceDelegate.trustAs; - sce.getTrusted = $sceDelegate.getTrusted; - sce.valueOf = $sceDelegate.valueOf; - - if (!enabled) { - sce.trustAs = sce.getTrusted = function(type, value) { return value; }; - sce.valueOf = identity; - } - - /** - * @ngdoc method - * @name $sce#parse - * - * @description - * Converts Angular {@link guide/expression expression} into a function. This is like {@link - * ng.$parse $parse} and is identical when the expression is a literal constant. Otherwise, it - * wraps the expression in a call to {@link ng.$sce#getTrusted $sce.getTrusted(*type*, - * *result*)} - * - * @param {string} type The kind of SCE context in which this result will be used. - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - sce.parseAs = function sceParseAs(type, expr) { - var parsed = $parse(expr); - if (parsed.literal && parsed.constant) { - return parsed; - } else { - return function sceParseAsTrusted(self, locals) { - return sce.getTrusted(type, parsed(self, locals)); - }; - } - }; - - /** - * @ngdoc method - * @name $sce#trustAs - * - * @description - * Delegates to {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs`}. As such, - * returns an object that is trusted by angular for use in specified strict contextual - * escaping contexts (such as ng-bind-html, ng-include, any src attribute - * interpolation, any dom event binding attribute interpolation such as for onclick, etc.) - * that uses the provided value. See * {@link ng.$sce $sce} for enabling strict contextual - * escaping. - * - * @param {string} type The kind of context in which this value is safe for use. e.g. url, - * resource_url, html, js and css. - * @param {*} value The value that that should be considered trusted/safe. - * @returns {*} A value that can be used to stand in for the provided `value` in places - * where Angular expects a $sce.trustAs() return value. - */ - - /** - * @ngdoc method - * @name $sce#trustAsHtml - * - * @description - * Shorthand method. `$sce.trustAsHtml(value)` → - * {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.HTML, value)`} - * - * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedHtml - * $sce.getTrustedHtml(value)} to obtain the original value. (privileged directives - * only accept expressions that are either literal constants or are the - * return value of {@link ng.$sce#trustAs $sce.trustAs}.) - */ - - /** - * @ngdoc method - * @name $sce#trustAsUrl - * - * @description - * Shorthand method. `$sce.trustAsUrl(value)` → - * {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.URL, value)`} - * - * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedUrl - * $sce.getTrustedUrl(value)} to obtain the original value. (privileged directives - * only accept expressions that are either literal constants or are the - * return value of {@link ng.$sce#trustAs $sce.trustAs}.) - */ - - /** - * @ngdoc method - * @name $sce#trustAsResourceUrl - * - * @description - * Shorthand method. `$sce.trustAsResourceUrl(value)` → - * {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.RESOURCE_URL, value)`} - * - * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedResourceUrl - * $sce.getTrustedResourceUrl(value)} to obtain the original value. (privileged directives - * only accept expressions that are either literal constants or are the return - * value of {@link ng.$sce#trustAs $sce.trustAs}.) - */ - - /** - * @ngdoc method - * @name $sce#trustAsJs - * - * @description - * Shorthand method. `$sce.trustAsJs(value)` → - * {@link ng.$sceDelegate#trustAs `$sceDelegate.trustAs($sce.JS, value)`} - * - * @param {*} value The value to trustAs. - * @returns {*} An object that can be passed to {@link ng.$sce#getTrustedJs - * $sce.getTrustedJs(value)} to obtain the original value. (privileged directives - * only accept expressions that are either literal constants or are the - * return value of {@link ng.$sce#trustAs $sce.trustAs}.) - */ - - /** - * @ngdoc method - * @name $sce#getTrusted - * - * @description - * Delegates to {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted`}. As such, - * takes the result of a {@link ng.$sce#trustAs `$sce.trustAs`}() call and returns the - * originally supplied value if the queried context type is a supertype of the created type. - * If this condition isn't satisfied, throws an exception. - * - * @param {string} type The kind of context in which this value is to be used. - * @param {*} maybeTrusted The result of a prior {@link ng.$sce#trustAs `$sce.trustAs`} - * call. - * @returns {*} The value the was originally provided to - * {@link ng.$sce#trustAs `$sce.trustAs`} if valid in this context. - * Otherwise, throws an exception. - */ - - /** - * @ngdoc method - * @name $sce#getTrustedHtml - * - * @description - * Shorthand method. `$sce.getTrustedHtml(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.HTML, value)`} - * - * @param {*} value The value to pass to `$sce.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.HTML, value)` - */ - - /** - * @ngdoc method - * @name $sce#getTrustedCss - * - * @description - * Shorthand method. `$sce.getTrustedCss(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.CSS, value)`} - * - * @param {*} value The value to pass to `$sce.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.CSS, value)` - */ - - /** - * @ngdoc method - * @name $sce#getTrustedUrl - * - * @description - * Shorthand method. `$sce.getTrustedUrl(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.URL, value)`} - * - * @param {*} value The value to pass to `$sce.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.URL, value)` - */ - - /** - * @ngdoc method - * @name $sce#getTrustedResourceUrl - * - * @description - * Shorthand method. `$sce.getTrustedResourceUrl(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.RESOURCE_URL, value)`} - * - * @param {*} value The value to pass to `$sceDelegate.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.RESOURCE_URL, value)` - */ - - /** - * @ngdoc method - * @name $sce#getTrustedJs - * - * @description - * Shorthand method. `$sce.getTrustedJs(value)` → - * {@link ng.$sceDelegate#getTrusted `$sceDelegate.getTrusted($sce.JS, value)`} - * - * @param {*} value The value to pass to `$sce.getTrusted`. - * @returns {*} The return value of `$sce.getTrusted($sce.JS, value)` - */ - - /** - * @ngdoc method - * @name $sce#parseAsHtml - * - * @description - * Shorthand method. `$sce.parseAsHtml(expression string)` → - * {@link ng.$sce#parse `$sce.parseAs($sce.HTML, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - /** - * @ngdoc method - * @name $sce#parseAsCss - * - * @description - * Shorthand method. `$sce.parseAsCss(value)` → - * {@link ng.$sce#parse `$sce.parseAs($sce.CSS, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - /** - * @ngdoc method - * @name $sce#parseAsUrl - * - * @description - * Shorthand method. `$sce.parseAsUrl(value)` → - * {@link ng.$sce#parse `$sce.parseAs($sce.URL, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - /** - * @ngdoc method - * @name $sce#parseAsResourceUrl - * - * @description - * Shorthand method. `$sce.parseAsResourceUrl(value)` → - * {@link ng.$sce#parse `$sce.parseAs($sce.RESOURCE_URL, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - /** - * @ngdoc method - * @name $sce#parseAsJs - * - * @description - * Shorthand method. `$sce.parseAsJs(value)` → - * {@link ng.$sce#parse `$sce.parseAs($sce.JS, value)`} - * - * @param {string} expression String expression to compile. - * @returns {function(context, locals)} a function which represents the compiled expression: - * - * * `context` – `{object}` – an object against which any expressions embedded in the strings - * are evaluated against (typically a scope object). - * * `locals` – `{object=}` – local variables context object, useful for overriding values in - * `context`. - */ - - // Shorthand delegations. - var parse = sce.parseAs, - getTrusted = sce.getTrusted, - trustAs = sce.trustAs; - - forEach(SCE_CONTEXTS, function (enumValue, name) { - var lName = lowercase(name); - sce[camelCase("parse_as_" + lName)] = function (expr) { - return parse(enumValue, expr); - }; - sce[camelCase("get_trusted_" + lName)] = function (value) { - return getTrusted(enumValue, value); - }; - sce[camelCase("trust_as_" + lName)] = function (value) { - return trustAs(enumValue, value); - }; - }); - - return sce; - }]; -} - -/** - * !!! This is an undocumented "private" service !!! - * - * @name $sniffer - * @requires $window - * @requires $document - * - * @property {boolean} history Does the browser support html5 history api ? - * @property {boolean} hashchange Does the browser support hashchange event ? - * @property {boolean} transitions Does the browser support CSS transition events ? - * @property {boolean} animations Does the browser support CSS animation events ? - * - * @description - * This is very simple implementation of testing browser's features. - */ -function $SnifferProvider() { - this.$get = ['$window', '$document', function($window, $document) { - var eventSupport = {}, - android = - int((/android (\d+)/.exec(lowercase(($window.navigator || {}).userAgent)) || [])[1]), - boxee = /Boxee/i.test(($window.navigator || {}).userAgent), - document = $document[0] || {}, - documentMode = document.documentMode, - vendorPrefix, - vendorRegex = /^(Moz|webkit|O|ms)(?=[A-Z])/, - bodyStyle = document.body && document.body.style, - transitions = false, - animations = false, - match; - - if (bodyStyle) { - for(var prop in bodyStyle) { - if(match = vendorRegex.exec(prop)) { - vendorPrefix = match[0]; - vendorPrefix = vendorPrefix.substr(0, 1).toUpperCase() + vendorPrefix.substr(1); - break; - } - } - - if(!vendorPrefix) { - vendorPrefix = ('WebkitOpacity' in bodyStyle) && 'webkit'; - } - - transitions = !!(('transition' in bodyStyle) || (vendorPrefix + 'Transition' in bodyStyle)); - animations = !!(('animation' in bodyStyle) || (vendorPrefix + 'Animation' in bodyStyle)); - - if (android && (!transitions||!animations)) { - transitions = isString(document.body.style.webkitTransition); - animations = isString(document.body.style.webkitAnimation); - } - } - - - return { - // Android has history.pushState, but it does not update location correctly - // so let's not use the history API at all. - // http://code.google.com/p/android/issues/detail?id=17471 - // https://github.com/angular/angular.js/issues/904 - - // older webkit browser (533.9) on Boxee box has exactly the same problem as Android has - // so let's not use the history API also - // We are purposefully using `!(android < 4)` to cover the case when `android` is undefined - // jshint -W018 - history: !!($window.history && $window.history.pushState && !(android < 4) && !boxee), - // jshint +W018 - hashchange: 'onhashchange' in $window && - // IE8 compatible mode lies - (!documentMode || documentMode > 7), - hasEvent: function(event) { - // IE9 implements 'input' event it's so fubared that we rather pretend that it doesn't have - // it. In particular the event is not fired when backspace or delete key are pressed or - // when cut operation is performed. - if (event == 'input' && msie == 9) return false; - - if (isUndefined(eventSupport[event])) { - var divElm = document.createElement('div'); - eventSupport[event] = 'on' + event in divElm; - } - - return eventSupport[event]; - }, - csp: csp(), - vendorPrefix: vendorPrefix, - transitions : transitions, - animations : animations, - android: android, - msie : msie, - msieDocumentMode: documentMode - }; - }]; -} - -function $TimeoutProvider() { - this.$get = ['$rootScope', '$browser', '$q', '$exceptionHandler', - function($rootScope, $browser, $q, $exceptionHandler) { - var deferreds = {}; - - - /** - * @ngdoc service - * @name $timeout - * - * @description - * Angular's wrapper for `window.setTimeout`. The `fn` function is wrapped into a try/catch - * block and delegates any exceptions to - * {@link ng.$exceptionHandler $exceptionHandler} service. - * - * The return value of registering a timeout function is a promise, which will be resolved when - * the timeout is reached and the timeout function is executed. - * - * To cancel a timeout request, call `$timeout.cancel(promise)`. - * - * In tests you can use {@link ngMock.$timeout `$timeout.flush()`} to - * synchronously flush the queue of deferred functions. - * - * @param {function()} fn A function, whose execution should be delayed. - * @param {number=} [delay=0] Delay in milliseconds. - * @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise - * will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block. - * @returns {Promise} Promise that will be resolved when the timeout is reached. The value this - * promise will be resolved with is the return value of the `fn` function. - * - */ - function timeout(fn, delay, invokeApply) { - var deferred = $q.defer(), - promise = deferred.promise, - skipApply = (isDefined(invokeApply) && !invokeApply), - timeoutId; - - timeoutId = $browser.defer(function() { - try { - deferred.resolve(fn()); - } catch(e) { - deferred.reject(e); - $exceptionHandler(e); - } - finally { - delete deferreds[promise.$$timeoutId]; - } - - if (!skipApply) $rootScope.$apply(); - }, delay); - - promise.$$timeoutId = timeoutId; - deferreds[timeoutId] = deferred; - - return promise; - } - - - /** - * @ngdoc method - * @name $timeout#cancel - * - * @description - * Cancels a task associated with the `promise`. As a result of this, the promise will be - * resolved with a rejection. - * - * @param {Promise=} promise Promise returned by the `$timeout` function. - * @returns {boolean} Returns `true` if the task hasn't executed yet and was successfully - * canceled. - */ - timeout.cancel = function(promise) { - if (promise && promise.$$timeoutId in deferreds) { - deferreds[promise.$$timeoutId].reject('canceled'); - delete deferreds[promise.$$timeoutId]; - return $browser.defer.cancel(promise.$$timeoutId); - } - return false; - }; - - return timeout; - }]; -} - -// NOTE: The usage of window and document instead of $window and $document here is -// deliberate. This service depends on the specific behavior of anchor nodes created by the -// browser (resolving and parsing URLs) that is unlikely to be provided by mock objects and -// cause us to break tests. In addition, when the browser resolves a URL for XHR, it -// doesn't know about mocked locations and resolves URLs to the real document - which is -// exactly the behavior needed here. There is little value is mocking these out for this -// service. -var urlParsingNode = document.createElement("a"); -var originUrl = urlResolve(window.location.href, true); - - -/** - * - * Implementation Notes for non-IE browsers - * ---------------------------------------- - * Assigning a URL to the href property of an anchor DOM node, even one attached to the DOM, - * results both in the normalizing and parsing of the URL. Normalizing means that a relative - * URL will be resolved into an absolute URL in the context of the application document. - * Parsing means that the anchor node's host, hostname, protocol, port, pathname and related - * properties are all populated to reflect the normalized URL. This approach has wide - * compatibility - Safari 1+, Mozilla 1+, Opera 7+,e etc. See - * http://www.aptana.com/reference/html/api/HTMLAnchorElement.html - * - * Implementation Notes for IE - * --------------------------- - * IE >= 8 and <= 10 normalizes the URL when assigned to the anchor node similar to the other - * browsers. However, the parsed components will not be set if the URL assigned did not specify - * them. (e.g. if you assign a.href = "foo", then a.protocol, a.host, etc. will be empty.) We - * work around that by performing the parsing in a 2nd step by taking a previously normalized - * URL (e.g. by assigning to a.href) and assigning it a.href again. This correctly populates the - * properties such as protocol, hostname, port, etc. - * - * IE7 does not normalize the URL when assigned to an anchor node. (Apparently, it does, if one - * uses the inner HTML approach to assign the URL as part of an HTML snippet - - * http://stackoverflow.com/a/472729) However, setting img[src] does normalize the URL. - * Unfortunately, setting img[src] to something like "javascript:foo" on IE throws an exception. - * Since the primary usage for normalizing URLs is to sanitize such URLs, we can't use that - * method and IE < 8 is unsupported. - * - * References: - * http://developer.mozilla.org/en-US/docs/Web/API/HTMLAnchorElement - * http://www.aptana.com/reference/html/api/HTMLAnchorElement.html - * http://url.spec.whatwg.org/#urlutils - * https://github.com/angular/angular.js/pull/2902 - * http://james.padolsey.com/javascript/parsing-urls-with-the-dom/ - * - * @function - * @param {string} url The URL to be parsed. - * @description Normalizes and parses a URL. - * @returns {object} Returns the normalized URL as a dictionary. - * - * | member name | Description | - * |---------------|----------------| - * | href | A normalized version of the provided URL if it was not an absolute URL | - * | protocol | The protocol including the trailing colon | - * | host | The host and port (if the port is non-default) of the normalizedUrl | - * | search | The search params, minus the question mark | - * | hash | The hash string, minus the hash symbol - * | hostname | The hostname - * | port | The port, without ":" - * | pathname | The pathname, beginning with "/" - * - */ -function urlResolve(url, base) { - var href = url; - - if (msie) { - // Normalize before parse. Refer Implementation Notes on why this is - // done in two steps on IE. - urlParsingNode.setAttribute("href", href); - href = urlParsingNode.href; - } - - urlParsingNode.setAttribute('href', href); - - // urlParsingNode provides the UrlUtils interface - http://url.spec.whatwg.org/#urlutils - return { - href: urlParsingNode.href, - protocol: urlParsingNode.protocol ? urlParsingNode.protocol.replace(/:$/, '') : '', - host: urlParsingNode.host, - search: urlParsingNode.search ? urlParsingNode.search.replace(/^\?/, '') : '', - hash: urlParsingNode.hash ? urlParsingNode.hash.replace(/^#/, '') : '', - hostname: urlParsingNode.hostname, - port: urlParsingNode.port, - pathname: (urlParsingNode.pathname.charAt(0) === '/') - ? urlParsingNode.pathname - : '/' + urlParsingNode.pathname - }; -} - -/** - * Parse a request URL and determine whether this is a same-origin request as the application document. - * - * @param {string|object} requestUrl The url of the request as a string that will be resolved - * or a parsed URL object. - * @returns {boolean} Whether the request is for the same origin as the application document. - */ -function urlIsSameOrigin(requestUrl) { - var parsed = (isString(requestUrl)) ? urlResolve(requestUrl) : requestUrl; - return (parsed.protocol === originUrl.protocol && - parsed.host === originUrl.host); -} - -/** - * @ngdoc service - * @name $window - * - * @description - * A reference to the browser's `window` object. While `window` - * is globally available in JavaScript, it causes testability problems, because - * it is a global variable. In angular we always refer to it through the - * `$window` service, so it may be overridden, removed or mocked for testing. - * - * Expressions, like the one defined for the `ngClick` directive in the example - * below, are evaluated with respect to the current scope. Therefore, there is - * no risk of inadvertently coding in a dependency on a global value in such an - * expression. - * - * @example - - - -
- - -
- - - it('should display the greeting in the input box', function() { - element(by.model('greeting')).sendKeys('Hello, E2E Tests'); - // If we click the button it will block the test runner - // element(':button').click(); - }); - - - */ -function $WindowProvider(){ - this.$get = valueFn(window); -} - -/** - * @ngdoc provider - * @name $filterProvider - * @description - * - * Filters are just functions which transform input to an output. However filters need to be - * Dependency Injected. To achieve this a filter definition consists of a factory function which is - * annotated with dependencies and is responsible for creating a filter function. - * - * ```js - * // Filter registration - * function MyModule($provide, $filterProvider) { - * // create a service to demonstrate injection (not always needed) - * $provide.value('greet', function(name){ - * return 'Hello ' + name + '!'; - * }); - * - * // register a filter factory which uses the - * // greet service to demonstrate DI. - * $filterProvider.register('greet', function(greet){ - * // return the filter function which uses the greet service - * // to generate salutation - * return function(text) { - * // filters need to be forgiving so check input validity - * return text && greet(text) || text; - * }; - * }); - * } - * ``` - * - * The filter function is registered with the `$injector` under the filter name suffix with - * `Filter`. - * - * ```js - * it('should be the same instance', inject( - * function($filterProvider) { - * $filterProvider.register('reverse', function(){ - * return ...; - * }); - * }, - * function($filter, reverseFilter) { - * expect($filter('reverse')).toBe(reverseFilter); - * }); - * ``` - * - * - * For more information about how angular filters work, and how to create your own filters, see - * {@link guide/filter Filters} in the Angular Developer Guide. - */ -/** - * @ngdoc method - * @name $filterProvider#register - * @description - * Register filter factory function. - * - * @param {String} name Name of the filter. - * @param {Function} fn The filter factory function which is injectable. - */ - - -/** - * @ngdoc service - * @name $filter - * @function - * @description - * Filters are used for formatting data displayed to the user. - * - * The general syntax in templates is as follows: - * - * {{ expression [| filter_name[:parameter_value] ... ] }} - * - * @param {String} name Name of the filter function to retrieve - * @return {Function} the filter function - */ -$FilterProvider.$inject = ['$provide']; -function $FilterProvider($provide) { - var suffix = 'Filter'; - - /** - * @ngdoc method - * @name $controllerProvider#register - * @param {string|Object} name Name of the filter function, or an object map of filters where - * the keys are the filter names and the values are the filter factories. - * @returns {Object} Registered filter instance, or if a map of filters was provided then a map - * of the registered filter instances. - */ - function register(name, factory) { - if(isObject(name)) { - var filters = {}; - forEach(name, function(filter, key) { - filters[key] = register(key, filter); - }); - return filters; - } else { - return $provide.factory(name + suffix, factory); - } - } - this.register = register; - - this.$get = ['$injector', function($injector) { - return function(name) { - return $injector.get(name + suffix); - }; - }]; - - //////////////////////////////////////// - - /* global - currencyFilter: false, - dateFilter: false, - filterFilter: false, - jsonFilter: false, - limitToFilter: false, - lowercaseFilter: false, - numberFilter: false, - orderByFilter: false, - uppercaseFilter: false, - */ - - register('currency', currencyFilter); - register('date', dateFilter); - register('filter', filterFilter); - register('json', jsonFilter); - register('limitTo', limitToFilter); - register('lowercase', lowercaseFilter); - register('number', numberFilter); - register('orderBy', orderByFilter); - register('uppercase', uppercaseFilter); -} - -/** - * @ngdoc filter - * @name filter - * @function - * - * @description - * Selects a subset of items from `array` and returns it as a new array. - * - * @param {Array} array The source array. - * @param {string|Object|function()} expression The predicate to be used for selecting items from - * `array`. - * - * Can be one of: - * - * - `string`: The string is evaluated as an expression and the resulting value is used for substring match against - * the contents of the `array`. All strings or objects with string properties in `array` that contain this string - * will be returned. The predicate can be negated by prefixing the string with `!`. - * - * - `Object`: A pattern object can be used to filter specific properties on objects contained - * by `array`. For example `{name:"M", phone:"1"}` predicate will return an array of items - * which have property `name` containing "M" and property `phone` containing "1". A special - * property name `$` can be used (as in `{$:"text"}`) to accept a match against any - * property of the object. That's equivalent to the simple substring match with a `string` - * as described above. - * - * - `function(value)`: A predicate function can be used to write arbitrary filters. The function is - * called for each element of `array`. The final result is an array of those elements that - * the predicate returned true for. - * - * @param {function(actual, expected)|true|undefined} comparator Comparator which is used in - * determining if the expected value (from the filter expression) and actual value (from - * the object in the array) should be considered a match. - * - * Can be one of: - * - * - `function(actual, expected)`: - * The function will be given the object value and the predicate value to compare and - * should return true if the item should be included in filtered result. - * - * - `true`: A shorthand for `function(actual, expected) { return angular.equals(expected, actual)}`. - * this is essentially strict comparison of expected and actual. - * - * - `false|undefined`: A short hand for a function which will look for a substring match in case - * insensitive way. - * - * @example - - -
- - Search: - - - - - - -
NamePhone
{{friend.name}}{{friend.phone}}
-
- Any:
- Name only
- Phone only
- Equality
- - - - - - -
NamePhone
{{friendObj.name}}{{friendObj.phone}}
- - - var expectFriendNames = function(expectedNames, key) { - element.all(by.repeater(key + ' in friends').column(key + '.name')).then(function(arr) { - arr.forEach(function(wd, i) { - expect(wd.getText()).toMatch(expectedNames[i]); - }); - }); - }; - - it('should search across all fields when filtering with a string', function() { - var searchText = element(by.model('searchText')); - searchText.clear(); - searchText.sendKeys('m'); - expectFriendNames(['Mary', 'Mike', 'Adam'], 'friend'); - - searchText.clear(); - searchText.sendKeys('76'); - expectFriendNames(['John', 'Julie'], 'friend'); - }); - - it('should search in specific fields when filtering with a predicate object', function() { - var searchAny = element(by.model('search.$')); - searchAny.clear(); - searchAny.sendKeys('i'); - expectFriendNames(['Mary', 'Mike', 'Julie', 'Juliette'], 'friendObj'); - }); - it('should use a equal comparison when comparator is true', function() { - var searchName = element(by.model('search.name')); - var strict = element(by.model('strict')); - searchName.clear(); - searchName.sendKeys('Julie'); - strict.click(); - expectFriendNames(['Julie'], 'friendObj'); - }); - - - */ -function filterFilter() { - return function(array, expression, comparator) { - if (!isArray(array)) return array; - - var comparatorType = typeof(comparator), - predicates = []; - - predicates.check = function(value) { - for (var j = 0; j < predicates.length; j++) { - if(!predicates[j](value)) { - return false; - } - } - return true; - }; - - if (comparatorType !== 'function') { - if (comparatorType === 'boolean' && comparator) { - comparator = function(obj, text) { - return angular.equals(obj, text); - }; - } else { - comparator = function(obj, text) { - if (obj && text && typeof obj === 'object' && typeof text === 'object') { - for (var objKey in obj) { - if (objKey.charAt(0) !== '$' && hasOwnProperty.call(obj, objKey) && - comparator(obj[objKey], text[objKey])) { - return true; - } - } - return false; - } - text = (''+text).toLowerCase(); - return (''+obj).toLowerCase().indexOf(text) > -1; - }; - } - } - - var search = function(obj, text){ - if (typeof text == 'string' && text.charAt(0) === '!') { - return !search(obj, text.substr(1)); - } - switch (typeof obj) { - case "boolean": - case "number": - case "string": - return comparator(obj, text); - case "object": - switch (typeof text) { - case "object": - return comparator(obj, text); - default: - for ( var objKey in obj) { - if (objKey.charAt(0) !== '$' && search(obj[objKey], text)) { - return true; - } - } - break; - } - return false; - case "array": - for ( var i = 0; i < obj.length; i++) { - if (search(obj[i], text)) { - return true; - } - } - return false; - default: - return false; - } - }; - switch (typeof expression) { - case "boolean": - case "number": - case "string": - // Set up expression object and fall through - expression = {$:expression}; - // jshint -W086 - case "object": - // jshint +W086 - for (var key in expression) { - (function(path) { - if (typeof expression[path] == 'undefined') return; - predicates.push(function(value) { - return search(path == '$' ? value : (value && value[path]), expression[path]); - }); - })(key); - } - break; - case 'function': - predicates.push(expression); - break; - default: - return array; - } - var filtered = []; - for ( var j = 0; j < array.length; j++) { - var value = array[j]; - if (predicates.check(value)) { - filtered.push(value); - } - } - return filtered; - }; -} - -/** - * @ngdoc filter - * @name currency - * @function - * - * @description - * Formats a number as a currency (ie $1,234.56). When no currency symbol is provided, default - * symbol for current locale is used. - * - * @param {number} amount Input to filter. - * @param {string=} symbol Currency symbol or identifier to be displayed. - * @returns {string} Formatted number. - * - * - * @example - - - -
-
- default currency symbol ($): {{amount | currency}}
- custom currency identifier (USD$): {{amount | currency:"USD$"}} -
- - - it('should init with 1234.56', function() { - expect(element(by.id('currency-default')).getText()).toBe('$1,234.56'); - expect(element(by.binding('amount | currency:"USD$"')).getText()).toBe('USD$1,234.56'); - }); - it('should update', function() { - if (browser.params.browser == 'safari') { - // Safari does not understand the minus key. See - // https://github.com/angular/protractor/issues/481 - return; - } - element(by.model('amount')).clear(); - element(by.model('amount')).sendKeys('-1234'); - expect(element(by.id('currency-default')).getText()).toBe('($1,234.00)'); - expect(element(by.binding('amount | currency:"USD$"')).getText()).toBe('(USD$1,234.00)'); - }); - - - */ -currencyFilter.$inject = ['$locale']; -function currencyFilter($locale) { - var formats = $locale.NUMBER_FORMATS; - return function(amount, currencySymbol){ - if (isUndefined(currencySymbol)) currencySymbol = formats.CURRENCY_SYM; - return formatNumber(amount, formats.PATTERNS[1], formats.GROUP_SEP, formats.DECIMAL_SEP, 2). - replace(/\u00A4/g, currencySymbol); - }; -} - -/** - * @ngdoc filter - * @name number - * @function - * - * @description - * Formats a number as text. - * - * If the input is not a number an empty string is returned. - * - * @param {number|string} number Number to format. - * @param {(number|string)=} fractionSize Number of decimal places to round the number to. - * If this is not provided then the fraction size is computed from the current locale's number - * formatting pattern. In the case of the default locale, it will be 3. - * @returns {string} Number rounded to decimalPlaces and places a “,” after each third digit. - * - * @example - - - -
- Enter number:
- Default formatting: {{val | number}}
- No fractions: {{val | number:0}}
- Negative number: {{-val | number:4}} -
- - - it('should format numbers', function() { - expect(element(by.id('number-default')).getText()).toBe('1,234.568'); - expect(element(by.binding('val | number:0')).getText()).toBe('1,235'); - expect(element(by.binding('-val | number:4')).getText()).toBe('-1,234.5679'); - }); - - it('should update', function() { - element(by.model('val')).clear(); - element(by.model('val')).sendKeys('3374.333'); - expect(element(by.id('number-default')).getText()).toBe('3,374.333'); - expect(element(by.binding('val | number:0')).getText()).toBe('3,374'); - expect(element(by.binding('-val | number:4')).getText()).toBe('-3,374.3330'); - }); - - - */ - - -numberFilter.$inject = ['$locale']; -function numberFilter($locale) { - var formats = $locale.NUMBER_FORMATS; - return function(number, fractionSize) { - return formatNumber(number, formats.PATTERNS[0], formats.GROUP_SEP, formats.DECIMAL_SEP, - fractionSize); - }; -} - -var DECIMAL_SEP = '.'; -function formatNumber(number, pattern, groupSep, decimalSep, fractionSize) { - if (number == null || !isFinite(number) || isObject(number)) return ''; - - var isNegative = number < 0; - number = Math.abs(number); - var numStr = number + '', - formatedText = '', - parts = []; - - var hasExponent = false; - if (numStr.indexOf('e') !== -1) { - var match = numStr.match(/([\d\.]+)e(-?)(\d+)/); - if (match && match[2] == '-' && match[3] > fractionSize + 1) { - numStr = '0'; - } else { - formatedText = numStr; - hasExponent = true; - } - } - - if (!hasExponent) { - var fractionLen = (numStr.split(DECIMAL_SEP)[1] || '').length; - - // determine fractionSize if it is not specified - if (isUndefined(fractionSize)) { - fractionSize = Math.min(Math.max(pattern.minFrac, fractionLen), pattern.maxFrac); - } - - var pow = Math.pow(10, fractionSize); - number = Math.round(number * pow) / pow; - var fraction = ('' + number).split(DECIMAL_SEP); - var whole = fraction[0]; - fraction = fraction[1] || ''; - - var i, pos = 0, - lgroup = pattern.lgSize, - group = pattern.gSize; - - if (whole.length >= (lgroup + group)) { - pos = whole.length - lgroup; - for (i = 0; i < pos; i++) { - if ((pos - i)%group === 0 && i !== 0) { - formatedText += groupSep; - } - formatedText += whole.charAt(i); - } - } - - for (i = pos; i < whole.length; i++) { - if ((whole.length - i)%lgroup === 0 && i !== 0) { - formatedText += groupSep; - } - formatedText += whole.charAt(i); - } - - // format fraction part. - while(fraction.length < fractionSize) { - fraction += '0'; - } - - if (fractionSize && fractionSize !== "0") formatedText += decimalSep + fraction.substr(0, fractionSize); - } else { - - if (fractionSize > 0 && number > -1 && number < 1) { - formatedText = number.toFixed(fractionSize); - } - } - - parts.push(isNegative ? pattern.negPre : pattern.posPre); - parts.push(formatedText); - parts.push(isNegative ? pattern.negSuf : pattern.posSuf); - return parts.join(''); -} - -function padNumber(num, digits, trim) { - var neg = ''; - if (num < 0) { - neg = '-'; - num = -num; - } - num = '' + num; - while(num.length < digits) num = '0' + num; - if (trim) - num = num.substr(num.length - digits); - return neg + num; -} - - -function dateGetter(name, size, offset, trim) { - offset = offset || 0; - return function(date) { - var value = date['get' + name](); - if (offset > 0 || value > -offset) - value += offset; - if (value === 0 && offset == -12 ) value = 12; - return padNumber(value, size, trim); - }; -} - -function dateStrGetter(name, shortForm) { - return function(date, formats) { - var value = date['get' + name](); - var get = uppercase(shortForm ? ('SHORT' + name) : name); - - return formats[get][value]; - }; -} - -function timeZoneGetter(date) { - var zone = -1 * date.getTimezoneOffset(); - var paddedZone = (zone >= 0) ? "+" : ""; - - paddedZone += padNumber(Math[zone > 0 ? 'floor' : 'ceil'](zone / 60), 2) + - padNumber(Math.abs(zone % 60), 2); - - return paddedZone; -} - -function ampmGetter(date, formats) { - return date.getHours() < 12 ? formats.AMPMS[0] : formats.AMPMS[1]; -} - -var DATE_FORMATS = { - yyyy: dateGetter('FullYear', 4), - yy: dateGetter('FullYear', 2, 0, true), - y: dateGetter('FullYear', 1), - MMMM: dateStrGetter('Month'), - MMM: dateStrGetter('Month', true), - MM: dateGetter('Month', 2, 1), - M: dateGetter('Month', 1, 1), - dd: dateGetter('Date', 2), - d: dateGetter('Date', 1), - HH: dateGetter('Hours', 2), - H: dateGetter('Hours', 1), - hh: dateGetter('Hours', 2, -12), - h: dateGetter('Hours', 1, -12), - mm: dateGetter('Minutes', 2), - m: dateGetter('Minutes', 1), - ss: dateGetter('Seconds', 2), - s: dateGetter('Seconds', 1), - // while ISO 8601 requires fractions to be prefixed with `.` or `,` - // we can be just safely rely on using `sss` since we currently don't support single or two digit fractions - sss: dateGetter('Milliseconds', 3), - EEEE: dateStrGetter('Day'), - EEE: dateStrGetter('Day', true), - a: ampmGetter, - Z: timeZoneGetter -}; - -var DATE_FORMATS_SPLIT = /((?:[^yMdHhmsaZE']+)|(?:'(?:[^']|'')*')|(?:E+|y+|M+|d+|H+|h+|m+|s+|a|Z))(.*)/, - NUMBER_STRING = /^\-?\d+$/; - -/** - * @ngdoc filter - * @name date - * @function - * - * @description - * Formats `date` to a string based on the requested `format`. - * - * `format` string can be composed of the following elements: - * - * * `'yyyy'`: 4 digit representation of year (e.g. AD 1 => 0001, AD 2010 => 2010) - * * `'yy'`: 2 digit representation of year, padded (00-99). (e.g. AD 2001 => 01, AD 2010 => 10) - * * `'y'`: 1 digit representation of year, e.g. (AD 1 => 1, AD 199 => 199) - * * `'MMMM'`: Month in year (January-December) - * * `'MMM'`: Month in year (Jan-Dec) - * * `'MM'`: Month in year, padded (01-12) - * * `'M'`: Month in year (1-12) - * * `'dd'`: Day in month, padded (01-31) - * * `'d'`: Day in month (1-31) - * * `'EEEE'`: Day in Week,(Sunday-Saturday) - * * `'EEE'`: Day in Week, (Sun-Sat) - * * `'HH'`: Hour in day, padded (00-23) - * * `'H'`: Hour in day (0-23) - * * `'hh'`: Hour in am/pm, padded (01-12) - * * `'h'`: Hour in am/pm, (1-12) - * * `'mm'`: Minute in hour, padded (00-59) - * * `'m'`: Minute in hour (0-59) - * * `'ss'`: Second in minute, padded (00-59) - * * `'s'`: Second in minute (0-59) - * * `'.sss' or ',sss'`: Millisecond in second, padded (000-999) - * * `'a'`: am/pm marker - * * `'Z'`: 4 digit (+sign) representation of the timezone offset (-1200-+1200) - * - * `format` string can also be one of the following predefined - * {@link guide/i18n localizable formats}: - * - * * `'medium'`: equivalent to `'MMM d, y h:mm:ss a'` for en_US locale - * (e.g. Sep 3, 2010 12:05:08 pm) - * * `'short'`: equivalent to `'M/d/yy h:mm a'` for en_US locale (e.g. 9/3/10 12:05 pm) - * * `'fullDate'`: equivalent to `'EEEE, MMMM d,y'` for en_US locale - * (e.g. Friday, September 3, 2010) - * * `'longDate'`: equivalent to `'MMMM d, y'` for en_US locale (e.g. September 3, 2010) - * * `'mediumDate'`: equivalent to `'MMM d, y'` for en_US locale (e.g. Sep 3, 2010) - * * `'shortDate'`: equivalent to `'M/d/yy'` for en_US locale (e.g. 9/3/10) - * * `'mediumTime'`: equivalent to `'h:mm:ss a'` for en_US locale (e.g. 12:05:08 pm) - * * `'shortTime'`: equivalent to `'h:mm a'` for en_US locale (e.g. 12:05 pm) - * - * `format` string can contain literal values. These need to be quoted with single quotes (e.g. - * `"h 'in the morning'"`). In order to output single quote, use two single quotes in a sequence - * (e.g. `"h 'o''clock'"`). - * - * @param {(Date|number|string)} date Date to format either as Date object, milliseconds (string or - * number) or various ISO 8601 datetime string formats (e.g. yyyy-MM-ddTHH:mm:ss.SSSZ and its - * shorter versions like yyyy-MM-ddTHH:mmZ, yyyy-MM-dd or yyyyMMddTHHmmssZ). If no timezone is - * specified in the string input, the time is considered to be in the local timezone. - * @param {string=} format Formatting rules (see Description). If not specified, - * `mediumDate` is used. - * @returns {string} Formatted string or the input if input is not recognized as date/millis. - * - * @example - - - {{1288323623006 | date:'medium'}}: - {{1288323623006 | date:'medium'}}
- {{1288323623006 | date:'yyyy-MM-dd HH:mm:ss Z'}}: - {{1288323623006 | date:'yyyy-MM-dd HH:mm:ss Z'}}
- {{1288323623006 | date:'MM/dd/yyyy @ h:mma'}}: - {{'1288323623006' | date:'MM/dd/yyyy @ h:mma'}}
- - - it('should format date', function() { - expect(element(by.binding("1288323623006 | date:'medium'")).getText()). - toMatch(/Oct 2\d, 2010 \d{1,2}:\d{2}:\d{2} (AM|PM)/); - expect(element(by.binding("1288323623006 | date:'yyyy-MM-dd HH:mm:ss Z'")).getText()). - toMatch(/2010\-10\-2\d \d{2}:\d{2}:\d{2} (\-|\+)?\d{4}/); - expect(element(by.binding("'1288323623006' | date:'MM/dd/yyyy @ h:mma'")).getText()). - toMatch(/10\/2\d\/2010 @ \d{1,2}:\d{2}(AM|PM)/); - }); - - - */ -dateFilter.$inject = ['$locale']; -function dateFilter($locale) { - - - var R_ISO8601_STR = /^(\d{4})-?(\d\d)-?(\d\d)(?:T(\d\d)(?::?(\d\d)(?::?(\d\d)(?:\.(\d+))?)?)?(Z|([+-])(\d\d):?(\d\d))?)?$/; - // 1 2 3 4 5 6 7 8 9 10 11 - function jsonStringToDate(string) { - var match; - if (match = string.match(R_ISO8601_STR)) { - var date = new Date(0), - tzHour = 0, - tzMin = 0, - dateSetter = match[8] ? date.setUTCFullYear : date.setFullYear, - timeSetter = match[8] ? date.setUTCHours : date.setHours; - - if (match[9]) { - tzHour = int(match[9] + match[10]); - tzMin = int(match[9] + match[11]); - } - dateSetter.call(date, int(match[1]), int(match[2]) - 1, int(match[3])); - var h = int(match[4]||0) - tzHour; - var m = int(match[5]||0) - tzMin; - var s = int(match[6]||0); - var ms = Math.round(parseFloat('0.' + (match[7]||0)) * 1000); - timeSetter.call(date, h, m, s, ms); - return date; - } - return string; - } - - - return function(date, format) { - var text = '', - parts = [], - fn, match; - - format = format || 'mediumDate'; - format = $locale.DATETIME_FORMATS[format] || format; - if (isString(date)) { - if (NUMBER_STRING.test(date)) { - date = int(date); - } else { - date = jsonStringToDate(date); - } - } - - if (isNumber(date)) { - date = new Date(date); - } - - if (!isDate(date)) { - return date; - } - - while(format) { - match = DATE_FORMATS_SPLIT.exec(format); - if (match) { - parts = concat(parts, match, 1); - format = parts.pop(); - } else { - parts.push(format); - format = null; - } - } - - forEach(parts, function(value){ - fn = DATE_FORMATS[value]; - text += fn ? fn(date, $locale.DATETIME_FORMATS) - : value.replace(/(^'|'$)/g, '').replace(/''/g, "'"); - }); - - return text; - }; -} - - -/** - * @ngdoc filter - * @name json - * @function - * - * @description - * Allows you to convert a JavaScript object into JSON string. - * - * This filter is mostly useful for debugging. When using the double curly {{value}} notation - * the binding is automatically converted to JSON. - * - * @param {*} object Any JavaScript object (including arrays and primitive types) to filter. - * @returns {string} JSON string. - * - * - * @example - - - 
{{ {'name':'value'} | json }}
- - - it('should jsonify filtered objects', function() { - expect(element(by.binding("{'name':'value'}")).getText()).toMatch(/\{\n "name": ?"value"\n}/); - }); - - - * - */ -function jsonFilter() { - return function(object) { - return toJson(object, true); - }; -} - - -/** - * @ngdoc filter - * @name lowercase - * @function - * @description - * Converts string to lowercase. - * @see angular.lowercase - */ -var lowercaseFilter = valueFn(lowercase); - - -/** - * @ngdoc filter - * @name uppercase - * @function - * @description - * Converts string to uppercase. - * @see angular.uppercase - */ -var uppercaseFilter = valueFn(uppercase); - -/** - * @ngdoc filter - * @name limitTo - * @function - * - * @description - * Creates a new array or string containing only a specified number of elements. The elements - * are taken from either the beginning or the end of the source array or string, as specified by - * the value and sign (positive or negative) of `limit`. - * - * @param {Array|string} input Source array or string to be limited. - * @param {string|number} limit The length of the returned array or string. If the `limit` number - * is positive, `limit` number of items from the beginning of the source array/string are copied. - * If the number is negative, `limit` number of items from the end of the source array/string - * are copied. The `limit` will be trimmed if it exceeds `array.length` - * @returns {Array|string} A new sub-array or substring of length `limit` or less if input array - * had less than `limit` elements. - * - * @example - - - -
- Limit {{numbers}} to: -

Output numbers: {{ numbers | limitTo:numLimit }}

- Limit {{letters}} to: -

Output letters: {{ letters | limitTo:letterLimit }}

-
- - - var numLimitInput = element(by.model('numLimit')); - var letterLimitInput = element(by.model('letterLimit')); - var limitedNumbers = element(by.binding('numbers | limitTo:numLimit')); - var limitedLetters = element(by.binding('letters | limitTo:letterLimit')); - - it('should limit the number array to first three items', function() { - expect(numLimitInput.getAttribute('value')).toBe('3'); - expect(letterLimitInput.getAttribute('value')).toBe('3'); - expect(limitedNumbers.getText()).toEqual('Output numbers: [1,2,3]'); - expect(limitedLetters.getText()).toEqual('Output letters: abc'); - }); - - it('should update the output when -3 is entered', function() { - numLimitInput.clear(); - numLimitInput.sendKeys('-3'); - letterLimitInput.clear(); - letterLimitInput.sendKeys('-3'); - expect(limitedNumbers.getText()).toEqual('Output numbers: [7,8,9]'); - expect(limitedLetters.getText()).toEqual('Output letters: ghi'); - }); - - it('should not exceed the maximum size of input array', function() { - numLimitInput.clear(); - numLimitInput.sendKeys('100'); - letterLimitInput.clear(); - letterLimitInput.sendKeys('100'); - expect(limitedNumbers.getText()).toEqual('Output numbers: [1,2,3,4,5,6,7,8,9]'); - expect(limitedLetters.getText()).toEqual('Output letters: abcdefghi'); - }); - - - */ -function limitToFilter(){ - return function(input, limit) { - if (!isArray(input) && !isString(input)) return input; - - limit = int(limit); - - if (isString(input)) { - //NaN check on limit - if (limit) { - return limit >= 0 ? input.slice(0, limit) : input.slice(limit, input.length); - } else { - return ""; - } - } - - var out = [], - i, n; - - // if abs(limit) exceeds maximum length, trim it - if (limit > input.length) - limit = input.length; - else if (limit < -input.length) - limit = -input.length; - - if (limit > 0) { - i = 0; - n = limit; - } else { - i = input.length + limit; - n = input.length; - } - - for (; i} expression A predicate to be - * used by the comparator to determine the order of elements. - * - * Can be one of: - * - * - `function`: Getter function. The result of this function will be sorted using the - * `<`, `=`, `>` operator. - * - `string`: An Angular expression which evaluates to an object to order by, such as 'name' - * to sort by a property called 'name'. Optionally prefixed with `+` or `-` to control - * ascending or descending sort order (for example, +name or -name). - * - `Array`: An array of function or string predicates. The first predicate in the array - * is used for sorting, but when two items are equivalent, the next predicate is used. - * - * @param {boolean=} reverse Reverse the order of the array. - * @returns {Array} Sorted copy of the source array. - * - * @example - - - -
- 
Sorting predicate = {{predicate}}; reverse = {{reverse}}
-
- [ unsorted ] - - - - - - - - - - - -
Name - (^)Phone NumberAge
{{friend.name}}{{friend.phone}}{{friend.age}}
-
- - - */ -orderByFilter.$inject = ['$parse']; -function orderByFilter($parse){ - return function(array, sortPredicate, reverseOrder) { - if (!isArray(array)) return array; - if (!sortPredicate) return array; - sortPredicate = isArray(sortPredicate) ? sortPredicate: [sortPredicate]; - sortPredicate = map(sortPredicate, function(predicate){ - var descending = false, get = predicate || identity; - if (isString(predicate)) { - if ((predicate.charAt(0) == '+' || predicate.charAt(0) == '-')) { - descending = predicate.charAt(0) == '-'; - predicate = predicate.substring(1); - } - get = $parse(predicate); - if (get.constant) { - var key = get(); - return reverseComparator(function(a,b) { - return compare(a[key], b[key]); - }, descending); - } - } - return reverseComparator(function(a,b){ - return compare(get(a),get(b)); - }, descending); - }); - var arrayCopy = []; - for ( var i = 0; i < array.length; i++) { arrayCopy.push(array[i]); } - return arrayCopy.sort(reverseComparator(comparator, reverseOrder)); - - function comparator(o1, o2){ - for ( var i = 0; i < sortPredicate.length; i++) { - var comp = sortPredicate[i](o1, o2); - if (comp !== 0) return comp; - } - return 0; - } - function reverseComparator(comp, descending) { - return toBoolean(descending) - ? function(a,b){return comp(b,a);} - : comp; - } - function compare(v1, v2){ - var t1 = typeof v1; - var t2 = typeof v2; - if (t1 == t2) { - if (t1 == "string") { - v1 = v1.toLowerCase(); - v2 = v2.toLowerCase(); - } - if (v1 === v2) return 0; - return v1 < v2 ? -1 : 1; - } else { - return t1 < t2 ? -1 : 1; - } - } - }; -} - -function ngDirective(directive) { - if (isFunction(directive)) { - directive = { - link: directive - }; - } - directive.restrict = directive.restrict || 'AC'; - return valueFn(directive); -} - -/** - * @ngdoc directive - * @name a - * @restrict E - * - * @description - * Modifies the default behavior of the html A tag so that the default action is prevented when - * the href attribute is empty. - * - * This change permits the easy creation of action links with the `ngClick` directive - * without changing the location or causing page reloads, e.g.: - * `Add Item` - */ -var htmlAnchorDirective = valueFn({ - restrict: 'E', - compile: function(element, attr) { - - if (msie <= 8) { - - // turn link into a stylable link in IE - // but only if it doesn't have name attribute, in which case it's an anchor - if (!attr.href && !attr.name) { - attr.$set('href', ''); - } - - // add a comment node to anchors to workaround IE bug that causes element content to be reset - // to new attribute content if attribute is updated with value containing @ and element also - // contains value with @ - // see issue #1949 - element.append(document.createComment('IE fix')); - } - - if (!attr.href && !attr.xlinkHref && !attr.name) { - return function(scope, element) { - // SVGAElement does not use the href attribute, but rather the 'xlinkHref' attribute. - var href = toString.call(element.prop('href')) === '[object SVGAnimatedString]' ? - 'xlink:href' : 'href'; - element.on('click', function(event){ - // if we have no href url, then don't navigate anywhere. - if (!element.attr(href)) { - event.preventDefault(); - } - }); - }; - } - } -}); - -/** - * @ngdoc directive - * @name ngHref - * @restrict A - * @priority 99 - * - * @description - * Using Angular markup like `{{hash}}` in an href attribute will - * make the link go to the wrong URL if the user clicks it before - * Angular has a chance to replace the `{{hash}}` markup with its - * value. Until Angular replaces the markup the link will be broken - * and will most likely return a 404 error. - * - * The `ngHref` directive solves this problem. - * - * The wrong way to write it: - * ```html - * - * ``` - * - * The correct way to write it: - * ```html - * - * ``` - * - * @element A - * @param {template} ngHref any string which can contain `{{}}` markup. - * - * @example - * This example shows various combinations of `href`, `ng-href` and `ng-click` attributes - * in links and their different behaviors: - - -
- link 1 (link, don't reload)
- link 2 (link, don't reload)
- link 3 (link, reload!)
- anchor (link, don't reload)
- anchor (no link)
- link (link, change location) - - - it('should execute ng-click but not reload when href without value', function() { - element(by.id('link-1')).click(); - expect(element(by.model('value')).getAttribute('value')).toEqual('1'); - expect(element(by.id('link-1')).getAttribute('href')).toBe(''); - }); - - it('should execute ng-click but not reload when href empty string', function() { - element(by.id('link-2')).click(); - expect(element(by.model('value')).getAttribute('value')).toEqual('2'); - expect(element(by.id('link-2')).getAttribute('href')).toBe(''); - }); - - it('should execute ng-click and change url when ng-href specified', function() { - expect(element(by.id('link-3')).getAttribute('href')).toMatch(/\/123$/); - - element(by.id('link-3')).click(); - - // At this point, we navigate away from an Angular page, so we need - // to use browser.driver to get the base webdriver. - - browser.wait(function() { - return browser.driver.getCurrentUrl().then(function(url) { - return url.match(/\/123$/); - }); - }, 1000, 'page should navigate to /123'); - }); - - xit('should execute ng-click but not reload when href empty string and name specified', function() { - element(by.id('link-4')).click(); - expect(element(by.model('value')).getAttribute('value')).toEqual('4'); - expect(element(by.id('link-4')).getAttribute('href')).toBe(''); - }); - - it('should execute ng-click but not reload when no href but name specified', function() { - element(by.id('link-5')).click(); - expect(element(by.model('value')).getAttribute('value')).toEqual('5'); - expect(element(by.id('link-5')).getAttribute('href')).toBe(null); - }); - - it('should only change url when only ng-href', function() { - element(by.model('value')).clear(); - element(by.model('value')).sendKeys('6'); - expect(element(by.id('link-6')).getAttribute('href')).toMatch(/\/6$/); - - element(by.id('link-6')).click(); - - // At this point, we navigate away from an Angular page, so we need - // to use browser.driver to get the base webdriver. - browser.wait(function() { - return browser.driver.getCurrentUrl().then(function(url) { - return url.match(/\/6$/); - }); - }, 1000, 'page should navigate to /6'); - }); - - - */ - -/** - * @ngdoc directive - * @name ngSrc - * @restrict A - * @priority 99 - * - * @description - * Using Angular markup like `{{hash}}` in a `src` attribute doesn't - * work right: The browser will fetch from the URL with the literal - * text `{{hash}}` until Angular replaces the expression inside - * `{{hash}}`. The `ngSrc` directive solves this problem. - * - * The buggy way to write it: - * ```html - * - * ``` - * - * The correct way to write it: - * ```html - * - * ``` - * - * @element IMG - * @param {template} ngSrc any string which can contain `{{}}` markup. - */ - -/** - * @ngdoc directive - * @name ngSrcset - * @restrict A - * @priority 99 - * - * @description - * Using Angular markup like `{{hash}}` in a `srcset` attribute doesn't - * work right: The browser will fetch from the URL with the literal - * text `{{hash}}` until Angular replaces the expression inside - * `{{hash}}`. The `ngSrcset` directive solves this problem. - * - * The buggy way to write it: - * ```html - * - * ``` - * - * The correct way to write it: - * ```html - * - * ``` - * - * @element IMG - * @param {template} ngSrcset any string which can contain `{{}}` markup. - */ - -/** - * @ngdoc directive - * @name ngDisabled - * @restrict A - * @priority 100 - * - * @description - * - * The following markup will make the button enabled on Chrome/Firefox but not on IE8 and older IEs: - * ```html - *
- * - *
- * ``` - * - * The HTML specification does not require browsers to preserve the values of boolean attributes - * such as disabled. (Their presence means true and their absence means false.) - * If we put an Angular interpolation expression into such an attribute then the - * binding information would be lost when the browser removes the attribute. - * The `ngDisabled` directive solves this problem for the `disabled` attribute. - * This complementary directive is not removed by the browser and so provides - * a permanent reliable place to store the binding information. - * - * @example - - - Click me to toggle:
- - - - it('should toggle button', function() { - expect(element(by.css('button')).getAttribute('disabled')).toBeFalsy(); - element(by.model('checked')).click(); - expect(element(by.css('button')).getAttribute('disabled')).toBeTruthy(); - }); - - - * - * @element INPUT - * @param {expression} ngDisabled If the {@link guide/expression expression} is truthy, - * then special attribute "disabled" will be set on the element - */ - - -/** - * @ngdoc directive - * @name ngChecked - * @restrict A - * @priority 100 - * - * @description - * The HTML specification does not require browsers to preserve the values of boolean attributes - * such as checked. (Their presence means true and their absence means false.) - * If we put an Angular interpolation expression into such an attribute then the - * binding information would be lost when the browser removes the attribute. - * The `ngChecked` directive solves this problem for the `checked` attribute. - * This complementary directive is not removed by the browser and so provides - * a permanent reliable place to store the binding information. - * @example - - - Check me to check both:
- - - - it('should check both checkBoxes', function() { - expect(element(by.id('checkSlave')).getAttribute('checked')).toBeFalsy(); - element(by.model('master')).click(); - expect(element(by.id('checkSlave')).getAttribute('checked')).toBeTruthy(); - }); - - - * - * @element INPUT - * @param {expression} ngChecked If the {@link guide/expression expression} is truthy, - * then special attribute "checked" will be set on the element - */ - - -/** - * @ngdoc directive - * @name ngReadonly - * @restrict A - * @priority 100 - * - * @description - * The HTML specification does not require browsers to preserve the values of boolean attributes - * such as readonly. (Their presence means true and their absence means false.) - * If we put an Angular interpolation expression into such an attribute then the - * binding information would be lost when the browser removes the attribute. - * The `ngReadonly` directive solves this problem for the `readonly` attribute. - * This complementary directive is not removed by the browser and so provides - * a permanent reliable place to store the binding information. - * @example - - - Check me to make text readonly:
- - - - it('should toggle readonly attr', function() { - expect(element(by.css('[type="text"]')).getAttribute('readonly')).toBeFalsy(); - element(by.model('checked')).click(); - expect(element(by.css('[type="text"]')).getAttribute('readonly')).toBeTruthy(); - }); - - - * - * @element INPUT - * @param {expression} ngReadonly If the {@link guide/expression expression} is truthy, - * then special attribute "readonly" will be set on the element - */ - - -/** - * @ngdoc directive - * @name ngSelected - * @restrict A - * @priority 100 - * - * @description - * The HTML specification does not require browsers to preserve the values of boolean attributes - * such as selected. (Their presence means true and their absence means false.) - * If we put an Angular interpolation expression into such an attribute then the - * binding information would be lost when the browser removes the attribute. - * The `ngSelected` directive solves this problem for the `selected` attribute. - * This complementary directive is not removed by the browser and so provides - * a permanent reliable place to store the binding information. - * - * @example - - - Check me to select:
- - - - it('should select Greetings!', function() { - expect(element(by.id('greet')).getAttribute('selected')).toBeFalsy(); - element(by.model('selected')).click(); - expect(element(by.id('greet')).getAttribute('selected')).toBeTruthy(); - }); - - - * - * @element OPTION - * @param {expression} ngSelected If the {@link guide/expression expression} is truthy, - * then special attribute "selected" will be set on the element - */ - -/** - * @ngdoc directive - * @name ngOpen - * @restrict A - * @priority 100 - * - * @description - * The HTML specification does not require browsers to preserve the values of boolean attributes - * such as open. (Their presence means true and their absence means false.) - * If we put an Angular interpolation expression into such an attribute then the - * binding information would be lost when the browser removes the attribute. - * The `ngOpen` directive solves this problem for the `open` attribute. - * This complementary directive is not removed by the browser and so provides - * a permanent reliable place to store the binding information. - * @example - - - Check me check multiple:
-
- Show/Hide me -
- - - it('should toggle open', function() { - expect(element(by.id('details')).getAttribute('open')).toBeFalsy(); - element(by.model('open')).click(); - expect(element(by.id('details')).getAttribute('open')).toBeTruthy(); - }); - - - * - * @element DETAILS - * @param {expression} ngOpen If the {@link guide/expression expression} is truthy, - * then special attribute "open" will be set on the element - */ - -var ngAttributeAliasDirectives = {}; - - -// boolean attrs are evaluated -forEach(BOOLEAN_ATTR, function(propName, attrName) { - // binding to multiple is not supported - if (propName == "multiple") return; - - var normalized = directiveNormalize('ng-' + attrName); - ngAttributeAliasDirectives[normalized] = function() { - return { - priority: 100, - link: function(scope, element, attr) { - scope.$watch(attr[normalized], function ngBooleanAttrWatchAction(value) { - attr.$set(attrName, !!value); - }); - } - }; - }; -}); - - -// ng-src, ng-srcset, ng-href are interpolated -forEach(['src', 'srcset', 'href'], function(attrName) { - var normalized = directiveNormalize('ng-' + attrName); - ngAttributeAliasDirectives[normalized] = function() { - return { - priority: 99, // it needs to run after the attributes are interpolated - link: function(scope, element, attr) { - var propName = attrName, - name = attrName; - - if (attrName === 'href' && - toString.call(element.prop('href')) === '[object SVGAnimatedString]') { - name = 'xlinkHref'; - attr.$attr[name] = 'xlink:href'; - propName = null; - } - - attr.$observe(normalized, function(value) { - if (!value) - return; - - attr.$set(name, value); - - // on IE, if "ng:src" directive declaration is used and "src" attribute doesn't exist - // then calling element.setAttribute('src', 'foo') doesn't do anything, so we need - // to set the property as well to achieve the desired effect. - // we use attr[attrName] value since $set can sanitize the url. - if (msie && propName) element.prop(propName, attr[name]); - }); - } - }; - }; -}); - -/* global -nullFormCtrl */ -var nullFormCtrl = { - $addControl: noop, - $removeControl: noop, - $setValidity: noop, - $setDirty: noop, - $setPristine: noop -}; - -/** - * @ngdoc type - * @name form.FormController - * - * @property {boolean} $pristine True if user has not interacted with the form yet. - * @property {boolean} $dirty True if user has already interacted with the form. - * @property {boolean} $valid True if all of the containing forms and controls are valid. - * @property {boolean} $invalid True if at least one containing control or form is invalid. - * - * @property {Object} $error Is an object hash, containing references to all invalid controls or - * forms, where: - * - * - keys are validation tokens (error names), - * - values are arrays of controls or forms that are invalid for given error name. - * - * - * Built-in validation tokens: - * - * - `email` - * - `max` - * - `maxlength` - * - `min` - * - `minlength` - * - `number` - * - `pattern` - * - `required` - * - `url` - * - * @description - * `FormController` keeps track of all its controls and nested forms as well as state of them, - * such as being valid/invalid or dirty/pristine. - * - * Each {@link ng.directive:form form} directive creates an instance - * of `FormController`. - * - */ -//asks for $scope to fool the BC controller module -FormController.$inject = ['$element', '$attrs', '$scope', '$animate']; -function FormController(element, attrs, $scope, $animate) { - var form = this, - parentForm = element.parent().controller('form') || nullFormCtrl, - invalidCount = 0, // used to easily determine if we are valid - errors = form.$error = {}, - controls = []; - - // init state - form.$name = attrs.name || attrs.ngForm; - form.$dirty = false; - form.$pristine = true; - form.$valid = true; - form.$invalid = false; - - parentForm.$addControl(form); - - // Setup initial state of the control - element.addClass(PRISTINE_CLASS); - toggleValidCss(true); - - // convenience method for easy toggling of classes - function toggleValidCss(isValid, validationErrorKey) { - validationErrorKey = validationErrorKey ? '-' + snake_case(validationErrorKey, '-') : ''; - $animate.removeClass(element, (isValid ? INVALID_CLASS : VALID_CLASS) + validationErrorKey); - $animate.addClass(element, (isValid ? VALID_CLASS : INVALID_CLASS) + validationErrorKey); - } - - /** - * @ngdoc method - * @name form.FormController#$addControl - * - * @description - * Register a control with the form. - * - * Input elements using ngModelController do this automatically when they are linked. - */ - form.$addControl = function(control) { - // Breaking change - before, inputs whose name was "hasOwnProperty" were quietly ignored - // and not added to the scope. Now we throw an error. - assertNotHasOwnProperty(control.$name, 'input'); - controls.push(control); - - if (control.$name) { - form[control.$name] = control; - } - }; - - /** - * @ngdoc method - * @name form.FormController#$removeControl - * - * @description - * Deregister a control from the form. - * - * Input elements using ngModelController do this automatically when they are destroyed. - */ - form.$removeControl = function(control) { - if (control.$name && form[control.$name] === control) { - delete form[control.$name]; - } - forEach(errors, function(queue, validationToken) { - form.$setValidity(validationToken, true, control); - }); - - arrayRemove(controls, control); - }; - - /** - * @ngdoc method - * @name form.FormController#$setValidity - * - * @description - * Sets the validity of a form control. - * - * This method will also propagate to parent forms. - */ - form.$setValidity = function(validationToken, isValid, control) { - var queue = errors[validationToken]; - - if (isValid) { - if (queue) { - arrayRemove(queue, control); - if (!queue.length) { - invalidCount--; - if (!invalidCount) { - toggleValidCss(isValid); - form.$valid = true; - form.$invalid = false; - } - errors[validationToken] = false; - toggleValidCss(true, validationToken); - parentForm.$setValidity(validationToken, true, form); - } - } - - } else { - if (!invalidCount) { - toggleValidCss(isValid); - } - if (queue) { - if (includes(queue, control)) return; - } else { - errors[validationToken] = queue = []; - invalidCount++; - toggleValidCss(false, validationToken); - parentForm.$setValidity(validationToken, false, form); - } - queue.push(control); - - form.$valid = false; - form.$invalid = true; - } - }; - - /** - * @ngdoc method - * @name form.FormController#$setDirty - * - * @description - * Sets the form to a dirty state. - * - * This method can be called to add the 'ng-dirty' class and set the form to a dirty - * state (ng-dirty class). This method will also propagate to parent forms. - */ - form.$setDirty = function() { - $animate.removeClass(element, PRISTINE_CLASS); - $animate.addClass(element, DIRTY_CLASS); - form.$dirty = true; - form.$pristine = false; - parentForm.$setDirty(); - }; - - /** - * @ngdoc method - * @name form.FormController#$setPristine - * - * @description - * Sets the form to its pristine state. - * - * This method can be called to remove the 'ng-dirty' class and set the form to its pristine - * state (ng-pristine class). This method will also propagate to all the controls contained - * in this form. - * - * Setting a form back to a pristine state is often useful when we want to 'reuse' a form after - * saving or resetting it. - */ - form.$setPristine = function () { - $animate.removeClass(element, DIRTY_CLASS); - $animate.addClass(element, PRISTINE_CLASS); - form.$dirty = false; - form.$pristine = true; - forEach(controls, function(control) { - control.$setPristine(); - }); - }; -} - - -/** - * @ngdoc directive - * @name ngForm - * @restrict EAC - * - * @description - * Nestable alias of {@link ng.directive:form `form`} directive. HTML - * does not allow nesting of form elements. It is useful to nest forms, for example if the validity of a - * sub-group of controls needs to be determined. - * - * Note: the purpose of `ngForm` is to group controls, - * but not to be a replacement for the `
` tag with all of its capabilities - * (e.g. posting to the server, ...). - * - * @param {string=} ngForm|name Name of the form. If specified, the form controller will be published into - * related scope, under this name. - * - */ - - /** - * @ngdoc directive - * @name form - * @restrict E - * - * @description - * Directive that instantiates - * {@link form.FormController FormController}. - * - * If the `name` attribute is specified, the form controller is published onto the current scope under - * this name. - * - * # Alias: {@link ng.directive:ngForm `ngForm`} - * - * In Angular forms can be nested. This means that the outer form is valid when all of the child - * forms are valid as well. However, browsers do not allow nesting of `` elements, so - * Angular provides the {@link ng.directive:ngForm `ngForm`} directive which behaves identically to - * `` but can be nested. This allows you to have nested forms, which is very useful when - * using Angular validation directives in forms that are dynamically generated using the - * {@link ng.directive:ngRepeat `ngRepeat`} directive. Since you cannot dynamically generate the `name` - * attribute of input elements using interpolation, you have to wrap each set of repeated inputs in an - * `ngForm` directive and nest these in an outer `form` element. - * - * - * # CSS classes - * - `ng-valid` is set if the form is valid. - * - `ng-invalid` is set if the form is invalid. - * - `ng-pristine` is set if the form is pristine. - * - `ng-dirty` is set if the form is dirty. - * - * Keep in mind that ngAnimate can detect each of these classes when added and removed. - * - * - * # Submitting a form and preventing the default action - * - * Since the role of forms in client-side Angular applications is different than in classical - * roundtrip apps, it is desirable for the browser not to translate the form submission into a full - * page reload that sends the data to the server. Instead some javascript logic should be triggered - * to handle the form submission in an application-specific way. - * - * For this reason, Angular prevents the default action (form submission to the server) unless the - * `` element has an `action` attribute specified. - * - * You can use one of the following two ways to specify what javascript method should be called when - * a form is submitted: - * - * - {@link ng.directive:ngSubmit ngSubmit} directive on the form element - * - {@link ng.directive:ngClick ngClick} directive on the first - * button or input field of type submit (input[type=submit]) - * - * To prevent double execution of the handler, use only one of the {@link ng.directive:ngSubmit ngSubmit} - * or {@link ng.directive:ngClick ngClick} directives. - * This is because of the following form submission rules in the HTML specification: - * - * - If a form has only one input field then hitting enter in this field triggers form submit - * (`ngSubmit`) - * - if a form has 2+ input fields and no buttons or input[type=submit] then hitting enter - * doesn't trigger submit - * - if a form has one or more input fields and one or more buttons or input[type=submit] then - * hitting enter in any of the input fields will trigger the click handler on the *first* button or - * input[type=submit] (`ngClick`) *and* a submit handler on the enclosing form (`ngSubmit`) - * - * @param {string=} name Name of the form. If specified, the form controller will be published into - * related scope, under this name. - * - * ## Animation Hooks - * - * Animations in ngForm are triggered when any of the associated CSS classes are added and removed. - * These classes are: `.ng-pristine`, `.ng-dirty`, `.ng-invalid` and `.ng-valid` as well as any - * other validations that are performed within the form. Animations in ngForm are similar to how - * they work in ngClass and animations can be hooked into using CSS transitions, keyframes as well - * as JS animations. - * - * The following example shows a simple way to utilize CSS transitions to style a form element - * that has been rendered as invalid after it has been validated: - * - * 
- * //be sure to include ngAnimate as a module to hook into more
- * //advanced animations
- * .my-form {
- *   transition:0.5s linear all;
- *   background: white;
- * }
- * .my-form.ng-invalid {
- *   background: red;
- *   color:white;
- * }
- *
- * - * @example - - - - - - userType: - Required!
- userType = {{userType}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
- - - - it('should initialize to model', function() { - var userType = element(by.binding('userType')); - var valid = element(by.binding('myForm.input.$valid')); - - expect(userType.getText()).toContain('guest'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - var userType = element(by.binding('userType')); - var valid = element(by.binding('myForm.input.$valid')); - var userInput = element(by.model('userType')); - - userInput.clear(); - userInput.sendKeys(''); - - expect(userType.getText()).toEqual('userType ='); - expect(valid.getText()).toContain('false'); - }); - -
- * - */ -var formDirectiveFactory = function(isNgForm) { - return ['$timeout', function($timeout) { - var formDirective = { - name: 'form', - restrict: isNgForm ? 'EAC' : 'E', - controller: FormController, - compile: function() { - return { - pre: function(scope, formElement, attr, controller) { - if (!attr.action) { - // we can't use jq events because if a form is destroyed during submission the default - // action is not prevented. see #1238 - // - // IE 9 is not affected because it doesn't fire a submit event and try to do a full - // page reload if the form was destroyed by submission of the form via a click handler - // on a button in the form. Looks like an IE9 specific bug. - var preventDefaultListener = function(event) { - event.preventDefault - ? event.preventDefault() - : event.returnValue = false; // IE - }; - - addEventListenerFn(formElement[0], 'submit', preventDefaultListener); - - // unregister the preventDefault listener so that we don't not leak memory but in a - // way that will achieve the prevention of the default action. - formElement.on('$destroy', function() { - $timeout(function() { - removeEventListenerFn(formElement[0], 'submit', preventDefaultListener); - }, 0, false); - }); - } - - var parentFormCtrl = formElement.parent().controller('form'), - alias = attr.name || attr.ngForm; - - if (alias) { - setter(scope, alias, controller, alias); - } - if (parentFormCtrl) { - formElement.on('$destroy', function() { - parentFormCtrl.$removeControl(controller); - if (alias) { - setter(scope, alias, undefined, alias); - } - extend(controller, nullFormCtrl); //stop propagating child destruction handlers upwards - }); - } - } - }; - } - }; - - return formDirective; - }]; -}; - -var formDirective = formDirectiveFactory(); -var ngFormDirective = formDirectiveFactory(true); - -/* global - - -VALID_CLASS, - -INVALID_CLASS, - -PRISTINE_CLASS, - -DIRTY_CLASS -*/ - -var URL_REGEXP = /^(ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?$/; -var EMAIL_REGEXP = /^[a-z0-9!#$%&'*+/=?^_`{|}~.-]+@[a-z0-9-]+(\.[a-z0-9-]+)*$/i; -var NUMBER_REGEXP = /^\s*(\-|\+)?(\d+|(\d*(\.\d*)))\s*$/; - -var inputType = { - - /** - * @ngdoc input - * @name input[text] - * - * @description - * Standard HTML text input with angular data binding. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} required Adds `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. - * @param {string=} ngPattern Sets `pattern` validation error key if the value does not match the - * RegExp pattern expression. Expected value is `/regexp/` for inline patterns or `regexp` for - * patterns defined as scope expressions. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * @param {boolean=} [ngTrim=true] If set to false Angular will not automatically trim the input. - * - * @example - - - -
- Single word: - - Required! - - Single word only! - - text = {{text}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var text = element(by.binding('text')); - var valid = element(by.binding('myForm.input.$valid')); - var input = element(by.model('text')); - - it('should initialize to model', function() { - expect(text.getText()).toContain('guest'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - input.clear(); - input.sendKeys(''); - - expect(text.getText()).toEqual('text ='); - expect(valid.getText()).toContain('false'); - }); - - it('should be invalid if multi word', function() { - input.clear(); - input.sendKeys('hello world'); - - expect(valid.getText()).toContain('false'); - }); - - - */ - 'text': textInputType, - - - /** - * @ngdoc input - * @name input[number] - * - * @description - * Text input with number validation and transformation. Sets the `number` validation - * error if not a valid number. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} min Sets the `min` validation error key if the value entered is less than `min`. - * @param {string=} max Sets the `max` validation error key if the value entered is greater than `max`. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. - * @param {string=} ngPattern Sets `pattern` validation error key if the value does not match the - * RegExp pattern expression. Expected value is `/regexp/` for inline patterns or `regexp` for - * patterns defined as scope expressions. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- Number: - - Required! - - Not valid number! - value = {{value}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var value = element(by.binding('value')); - var valid = element(by.binding('myForm.input.$valid')); - var input = element(by.model('value')); - - it('should initialize to model', function() { - expect(value.getText()).toContain('12'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - input.clear(); - input.sendKeys(''); - expect(value.getText()).toEqual('value ='); - expect(valid.getText()).toContain('false'); - }); - - it('should be invalid if over max', function() { - input.clear(); - input.sendKeys('123'); - expect(value.getText()).toEqual('value ='); - expect(valid.getText()).toContain('false'); - }); - - - */ - 'number': numberInputType, - - - /** - * @ngdoc input - * @name input[url] - * - * @description - * Text input with URL validation. Sets the `url` validation error key if the content is not a - * valid URL. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. - * @param {string=} ngPattern Sets `pattern` validation error key if the value does not match the - * RegExp pattern expression. Expected value is `/regexp/` for inline patterns or `regexp` for - * patterns defined as scope expressions. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- URL: - - Required! - - Not valid url! - text = {{text}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
- myForm.$error.url = {{!!myForm.$error.url}}
-
- - - var text = element(by.binding('text')); - var valid = element(by.binding('myForm.input.$valid')); - var input = element(by.model('text')); - - it('should initialize to model', function() { - expect(text.getText()).toContain('http://google.com'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - input.clear(); - input.sendKeys(''); - - expect(text.getText()).toEqual('text ='); - expect(valid.getText()).toContain('false'); - }); - - it('should be invalid if not url', function() { - input.clear(); - input.sendKeys('box'); - - expect(valid.getText()).toContain('false'); - }); - - - */ - 'url': urlInputType, - - - /** - * @ngdoc input - * @name input[email] - * - * @description - * Text input with email validation. Sets the `email` validation error key if not a valid email - * address. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. - * @param {string=} ngPattern Sets `pattern` validation error key if the value does not match the - * RegExp pattern expression. Expected value is `/regexp/` for inline patterns or `regexp` for - * patterns defined as scope expressions. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- Email: - - Required! - - Not valid email! - text = {{text}}
- myForm.input.$valid = {{myForm.input.$valid}}
- myForm.input.$error = {{myForm.input.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
- myForm.$error.email = {{!!myForm.$error.email}}
-
- - - var text = element(by.binding('text')); - var valid = element(by.binding('myForm.input.$valid')); - var input = element(by.model('text')); - - it('should initialize to model', function() { - expect(text.getText()).toContain('me@example.com'); - expect(valid.getText()).toContain('true'); - }); - - it('should be invalid if empty', function() { - input.clear(); - input.sendKeys(''); - expect(text.getText()).toEqual('text ='); - expect(valid.getText()).toContain('false'); - }); - - it('should be invalid if not email', function() { - input.clear(); - input.sendKeys('xxx'); - - expect(valid.getText()).toContain('false'); - }); - - - */ - 'email': emailInputType, - - - /** - * @ngdoc input - * @name input[radio] - * - * @description - * HTML radio button. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string} value The value to which the expression should be set when selected. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * @param {string} ngValue Angular expression which sets the value to which the expression should - * be set when selected. - * - * @example - - - -
- Red
- Green
- Blue
- color = {{color | json}}
-
- Note that `ng-value="specialValue"` sets radio item's value to be the value of `$scope.specialValue`. - - - it('should change state', function() { - var color = element(by.binding('color')); - - expect(color.getText()).toContain('blue'); - - element.all(by.model('color')).get(0).click(); - - expect(color.getText()).toContain('red'); - }); - - - */ - 'radio': radioInputType, - - - /** - * @ngdoc input - * @name input[checkbox] - * - * @description - * HTML checkbox. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} ngTrueValue The value to which the expression should be set when selected. - * @param {string=} ngFalseValue The value to which the expression should be set when not selected. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
- Value1:
- Value2:
- value1 = {{value1}}
- value2 = {{value2}}
-
- - - it('should change state', function() { - var value1 = element(by.binding('value1')); - var value2 = element(by.binding('value2')); - - expect(value1.getText()).toContain('true'); - expect(value2.getText()).toContain('YES'); - - element(by.model('value1')).click(); - element(by.model('value2')).click(); - - expect(value1.getText()).toContain('false'); - expect(value2.getText()).toContain('NO'); - }); - - - */ - 'checkbox': checkboxInputType, - - 'hidden': noop, - 'button': noop, - 'submit': noop, - 'reset': noop, - 'file': noop -}; - -// A helper function to call $setValidity and return the value / undefined, -// a pattern that is repeated a lot in the input validation logic. -function validate(ctrl, validatorName, validity, value){ - ctrl.$setValidity(validatorName, validity); - return validity ? value : undefined; -} - - -function addNativeHtml5Validators(ctrl, validatorName, element) { - var validity = element.prop('validity'); - if (isObject(validity)) { - var validator = function(value) { - // Don't overwrite previous validation, don't consider valueMissing to apply (ng-required can - // perform the required validation) - if (!ctrl.$error[validatorName] && (validity.badInput || validity.customError || - validity.typeMismatch) && !validity.valueMissing) { - ctrl.$setValidity(validatorName, false); - return; - } - return value; - }; - ctrl.$parsers.push(validator); - } -} - -function textInputType(scope, element, attr, ctrl, $sniffer, $browser) { - var validity = element.prop('validity'); - // In composition mode, users are still inputing intermediate text buffer, - // hold the listener until composition is done. - // More about composition events: https://developer.mozilla.org/en-US/docs/Web/API/CompositionEvent - if (!$sniffer.android) { - var composing = false; - - element.on('compositionstart', function(data) { - composing = true; - }); - - element.on('compositionend', function() { - composing = false; - listener(); - }); - } - - var listener = function() { - if (composing) return; - var value = element.val(); - - // By default we will trim the value - // If the attribute ng-trim exists we will avoid trimming - // e.g. - if (toBoolean(attr.ngTrim || 'T')) { - value = trim(value); - } - - if (ctrl.$viewValue !== value || - // If the value is still empty/falsy, and there is no `required` error, run validators - // again. This enables HTML5 constraint validation errors to affect Angular validation - // even when the first character entered causes an error. - (validity && value === '' && !validity.valueMissing)) { - if (scope.$$phase) { - ctrl.$setViewValue(value); - } else { - scope.$apply(function() { - ctrl.$setViewValue(value); - }); - } - } - }; - - // if the browser does support "input" event, we are fine - except on IE9 which doesn't fire the - // input event on backspace, delete or cut - if ($sniffer.hasEvent('input')) { - element.on('input', listener); - } else { - var timeout; - - var deferListener = function() { - if (!timeout) { - timeout = $browser.defer(function() { - listener(); - timeout = null; - }); - } - }; - - element.on('keydown', function(event) { - var key = event.keyCode; - - // ignore - // command modifiers arrows - if (key === 91 || (15 < key && key < 19) || (37 <= key && key <= 40)) return; - - deferListener(); - }); - - // if user modifies input value using context menu in IE, we need "paste" and "cut" events to catch it - if ($sniffer.hasEvent('paste')) { - element.on('paste cut', deferListener); - } - } - - // if user paste into input using mouse on older browser - // or form autocomplete on newer browser, we need "change" event to catch it - element.on('change', listener); - - ctrl.$render = function() { - element.val(ctrl.$isEmpty(ctrl.$viewValue) ? '' : ctrl.$viewValue); - }; - - // pattern validator - var pattern = attr.ngPattern, - patternValidator, - match; - - if (pattern) { - var validateRegex = function(regexp, value) { - return validate(ctrl, 'pattern', ctrl.$isEmpty(value) || regexp.test(value), value); - }; - match = pattern.match(/^\/(.*)\/([gim]*)$/); - if (match) { - pattern = new RegExp(match[1], match[2]); - patternValidator = function(value) { - return validateRegex(pattern, value); - }; - } else { - patternValidator = function(value) { - var patternObj = scope.$eval(pattern); - - if (!patternObj || !patternObj.test) { - throw minErr('ngPattern')('noregexp', - 'Expected {0} to be a RegExp but was {1}. Element: {2}', pattern, - patternObj, startingTag(element)); - } - return validateRegex(patternObj, value); - }; - } - - ctrl.$formatters.push(patternValidator); - ctrl.$parsers.push(patternValidator); - } - - // min length validator - if (attr.ngMinlength) { - var minlength = int(attr.ngMinlength); - var minLengthValidator = function(value) { - return validate(ctrl, 'minlength', ctrl.$isEmpty(value) || value.length >= minlength, value); - }; - - ctrl.$parsers.push(minLengthValidator); - ctrl.$formatters.push(minLengthValidator); - } - - // max length validator - if (attr.ngMaxlength) { - var maxlength = int(attr.ngMaxlength); - var maxLengthValidator = function(value) { - return validate(ctrl, 'maxlength', ctrl.$isEmpty(value) || value.length <= maxlength, value); - }; - - ctrl.$parsers.push(maxLengthValidator); - ctrl.$formatters.push(maxLengthValidator); - } -} - -function numberInputType(scope, element, attr, ctrl, $sniffer, $browser) { - textInputType(scope, element, attr, ctrl, $sniffer, $browser); - - ctrl.$parsers.push(function(value) { - var empty = ctrl.$isEmpty(value); - if (empty || NUMBER_REGEXP.test(value)) { - ctrl.$setValidity('number', true); - return value === '' ? null : (empty ? value : parseFloat(value)); - } else { - ctrl.$setValidity('number', false); - return undefined; - } - }); - - addNativeHtml5Validators(ctrl, 'number', element); - - ctrl.$formatters.push(function(value) { - return ctrl.$isEmpty(value) ? '' : '' + value; - }); - - if (attr.min) { - var minValidator = function(value) { - var min = parseFloat(attr.min); - return validate(ctrl, 'min', ctrl.$isEmpty(value) || value >= min, value); - }; - - ctrl.$parsers.push(minValidator); - ctrl.$formatters.push(minValidator); - } - - if (attr.max) { - var maxValidator = function(value) { - var max = parseFloat(attr.max); - return validate(ctrl, 'max', ctrl.$isEmpty(value) || value <= max, value); - }; - - ctrl.$parsers.push(maxValidator); - ctrl.$formatters.push(maxValidator); - } - - ctrl.$formatters.push(function(value) { - return validate(ctrl, 'number', ctrl.$isEmpty(value) || isNumber(value), value); - }); -} - -function urlInputType(scope, element, attr, ctrl, $sniffer, $browser) { - textInputType(scope, element, attr, ctrl, $sniffer, $browser); - - var urlValidator = function(value) { - return validate(ctrl, 'url', ctrl.$isEmpty(value) || URL_REGEXP.test(value), value); - }; - - ctrl.$formatters.push(urlValidator); - ctrl.$parsers.push(urlValidator); -} - -function emailInputType(scope, element, attr, ctrl, $sniffer, $browser) { - textInputType(scope, element, attr, ctrl, $sniffer, $browser); - - var emailValidator = function(value) { - return validate(ctrl, 'email', ctrl.$isEmpty(value) || EMAIL_REGEXP.test(value), value); - }; - - ctrl.$formatters.push(emailValidator); - ctrl.$parsers.push(emailValidator); -} - -function radioInputType(scope, element, attr, ctrl) { - // make the name unique, if not defined - if (isUndefined(attr.name)) { - element.attr('name', nextUid()); - } - - element.on('click', function() { - if (element[0].checked) { - scope.$apply(function() { - ctrl.$setViewValue(attr.value); - }); - } - }); - - ctrl.$render = function() { - var value = attr.value; - element[0].checked = (value == ctrl.$viewValue); - }; - - attr.$observe('value', ctrl.$render); -} - -function checkboxInputType(scope, element, attr, ctrl) { - var trueValue = attr.ngTrueValue, - falseValue = attr.ngFalseValue; - - if (!isString(trueValue)) trueValue = true; - if (!isString(falseValue)) falseValue = false; - - element.on('click', function() { - scope.$apply(function() { - ctrl.$setViewValue(element[0].checked); - }); - }); - - ctrl.$render = function() { - element[0].checked = ctrl.$viewValue; - }; - - // Override the standard `$isEmpty` because a value of `false` means empty in a checkbox. - ctrl.$isEmpty = function(value) { - return value !== trueValue; - }; - - ctrl.$formatters.push(function(value) { - return value === trueValue; - }); - - ctrl.$parsers.push(function(value) { - return value ? trueValue : falseValue; - }); -} - - -/** - * @ngdoc directive - * @name textarea - * @restrict E - * - * @description - * HTML textarea element control with angular data-binding. The data-binding and validation - * properties of this element are exactly the same as those of the - * {@link ng.directive:input input element}. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {string=} ngRequired Adds `required` attribute and `required` validation constraint to - * the element when the ngRequired expression evaluates to true. Use `ngRequired` instead of - * `required` when you want to data-bind to the `required` attribute. - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. - * @param {string=} ngPattern Sets `pattern` validation error key if the value does not match the - * RegExp pattern expression. Expected value is `/regexp/` for inline patterns or `regexp` for - * patterns defined as scope expressions. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - */ - - -/** - * @ngdoc directive - * @name input - * @restrict E - * - * @description - * HTML input element control with angular data-binding. Input control follows HTML5 input types - * and polyfills the HTML5 validation behavior for older browsers. - * - * @param {string} ngModel Assignable angular expression to data-bind to. - * @param {string=} name Property name of the form under which the control is published. - * @param {string=} required Sets `required` validation error key if the value is not entered. - * @param {boolean=} ngRequired Sets `required` attribute if set to true - * @param {number=} ngMinlength Sets `minlength` validation error key if the value is shorter than - * minlength. - * @param {number=} ngMaxlength Sets `maxlength` validation error key if the value is longer than - * maxlength. - * @param {string=} ngPattern Sets `pattern` validation error key if the value does not match the - * RegExp pattern expression. Expected value is `/regexp/` for inline patterns or `regexp` for - * patterns defined as scope expressions. - * @param {string=} ngChange Angular expression to be executed when input changes due to user - * interaction with the input element. - * - * @example - - - -
-
- User name: - - Required!
- Last name: - - Too short! - - Too long!
-
-
- user = {{user}}
- myForm.userName.$valid = {{myForm.userName.$valid}}
- myForm.userName.$error = {{myForm.userName.$error}}
- myForm.lastName.$valid = {{myForm.lastName.$valid}}
- myForm.lastName.$error = {{myForm.lastName.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
- myForm.$error.minlength = {{!!myForm.$error.minlength}}
- myForm.$error.maxlength = {{!!myForm.$error.maxlength}}
-
- - - var user = element(by.binding('{{user}}')); - var userNameValid = element(by.binding('myForm.userName.$valid')); - var lastNameValid = element(by.binding('myForm.lastName.$valid')); - var lastNameError = element(by.binding('myForm.lastName.$error')); - var formValid = element(by.binding('myForm.$valid')); - var userNameInput = element(by.model('user.name')); - var userLastInput = element(by.model('user.last')); - - it('should initialize to model', function() { - expect(user.getText()).toContain('{"name":"guest","last":"visitor"}'); - expect(userNameValid.getText()).toContain('true'); - expect(formValid.getText()).toContain('true'); - }); - - it('should be invalid if empty when required', function() { - userNameInput.clear(); - userNameInput.sendKeys(''); - - expect(user.getText()).toContain('{"last":"visitor"}'); - expect(userNameValid.getText()).toContain('false'); - expect(formValid.getText()).toContain('false'); - }); - - it('should be valid if empty when min length is set', function() { - userLastInput.clear(); - userLastInput.sendKeys(''); - - expect(user.getText()).toContain('{"name":"guest","last":""}'); - expect(lastNameValid.getText()).toContain('true'); - expect(formValid.getText()).toContain('true'); - }); - - it('should be invalid if less than required min length', function() { - userLastInput.clear(); - userLastInput.sendKeys('xx'); - - expect(user.getText()).toContain('{"name":"guest"}'); - expect(lastNameValid.getText()).toContain('false'); - expect(lastNameError.getText()).toContain('minlength'); - expect(formValid.getText()).toContain('false'); - }); - - it('should be invalid if longer than max length', function() { - userLastInput.clear(); - userLastInput.sendKeys('some ridiculously long name'); - - expect(user.getText()).toContain('{"name":"guest"}'); - expect(lastNameValid.getText()).toContain('false'); - expect(lastNameError.getText()).toContain('maxlength'); - expect(formValid.getText()).toContain('false'); - }); - - - */ -var inputDirective = ['$browser', '$sniffer', function($browser, $sniffer) { - return { - restrict: 'E', - require: '?ngModel', - link: function(scope, element, attr, ctrl) { - if (ctrl) { - (inputType[lowercase(attr.type)] || inputType.text)(scope, element, attr, ctrl, $sniffer, - $browser); - } - } - }; -}]; - -var VALID_CLASS = 'ng-valid', - INVALID_CLASS = 'ng-invalid', - PRISTINE_CLASS = 'ng-pristine', - DIRTY_CLASS = 'ng-dirty'; - -/** - * @ngdoc type - * @name ngModel.NgModelController - * - * @property {string} $viewValue Actual string value in the view. - * @property {*} $modelValue The value in the model, that the control is bound to. - * @property {Array.} $parsers Array of functions to execute, as a pipeline, whenever - the control reads value from the DOM. Each function is called, in turn, passing the value - through to the next. The last return value is used to populate the model. - Used to sanitize / convert the value as well as validation. For validation, - the parsers should update the validity state using - {@link ngModel.NgModelController#$setValidity $setValidity()}, - and return `undefined` for invalid values. - - * - * @property {Array.} $formatters Array of functions to execute, as a pipeline, whenever - the model value changes. Each function is called, in turn, passing the value through to the - next. Used to format / convert values for display in the control and validation. - * ```js - * function formatter(value) { - * if (value) { - * return value.toUpperCase(); - * } - * } - * ngModel.$formatters.push(formatter); - * ``` - * - * @property {Array.} $viewChangeListeners Array of functions to execute whenever the - * view value has changed. It is called with no arguments, and its return value is ignored. - * This can be used in place of additional $watches against the model value. - * - * @property {Object} $error An object hash with all errors as keys. - * - * @property {boolean} $pristine True if user has not interacted with the control yet. - * @property {boolean} $dirty True if user has already interacted with the control. - * @property {boolean} $valid True if there is no error. - * @property {boolean} $invalid True if at least one error on the control. - * - * @description - * - * `NgModelController` provides API for the `ng-model` directive. The controller contains - * services for data-binding, validation, CSS updates, and value formatting and parsing. It - * purposefully does not contain any logic which deals with DOM rendering or listening to - * DOM events. Such DOM related logic should be provided by other directives which make use of - * `NgModelController` for data-binding. - * - * ## Custom Control Example - * This example shows how to use `NgModelController` with a custom control to achieve - * data-binding. Notice how different directives (`contenteditable`, `ng-model`, and `required`) - * collaborate together to achieve the desired result. - * - * Note that `contenteditable` is an HTML5 attribute, which tells the browser to let the element - * contents be edited in place by the user. This will not work on older browsers. - * - * - - [contenteditable] { - border: 1px solid black; - background-color: white; - min-height: 20px; - } - - .ng-invalid { - border: 1px solid red; - } - - - - angular.module('customControl', []). - directive('contenteditable', function() { - return { - restrict: 'A', // only activate on element attribute - require: '?ngModel', // get a hold of NgModelController - link: function(scope, element, attrs, ngModel) { - if(!ngModel) return; // do nothing if no ng-model - - // Specify how UI should be updated - ngModel.$render = function() { - element.html(ngModel.$viewValue || ''); - }; - - // Listen for change events to enable binding - element.on('blur keyup change', function() { - scope.$apply(read); - }); - read(); // initialize - - // Write data to the model - function read() { - var html = element.html(); - // When we clear the content editable the browser leaves a
behind - // If strip-br attribute is provided then we strip this out - if( attrs.stripBr && html == '
' ) { - html = ''; - } - ngModel.$setViewValue(html); - } - } - }; - }); - - -
-
Change me!
- Required! -
- -
- - - it('should data-bind and become invalid', function() { - if (browser.params.browser == 'safari' || browser.params.browser == 'firefox') { - // SafariDriver can't handle contenteditable - // and Firefox driver can't clear contenteditables very well - return; - } - var contentEditable = element(by.css('[contenteditable]')); - var content = 'Change me!'; - - expect(contentEditable.getText()).toEqual(content); - - contentEditable.clear(); - contentEditable.sendKeys(protractor.Key.BACK_SPACE); - expect(contentEditable.getText()).toEqual(''); - expect(contentEditable.getAttribute('class')).toMatch(/ng-invalid-required/); - }); - - * - * - * - */ -var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$parse', '$animate', - function($scope, $exceptionHandler, $attr, $element, $parse, $animate) { - this.$viewValue = Number.NaN; - this.$modelValue = Number.NaN; - this.$parsers = []; - this.$formatters = []; - this.$viewChangeListeners = []; - this.$pristine = true; - this.$dirty = false; - this.$valid = true; - this.$invalid = false; - this.$name = $attr.name; - - var ngModelGet = $parse($attr.ngModel), - ngModelSet = ngModelGet.assign; - - if (!ngModelSet) { - throw minErr('ngModel')('nonassign', "Expression '{0}' is non-assignable. Element: {1}", - $attr.ngModel, startingTag($element)); - } - - /** - * @ngdoc method - * @name ngModel.NgModelController#$render - * - * @description - * Called when the view needs to be updated. It is expected that the user of the ng-model - * directive will implement this method. - */ - this.$render = noop; - - /** - * @ngdoc method - * @name ngModel.NgModelController#$isEmpty - * - * @description - * This is called when we need to determine if the value of the input is empty. - * - * For instance, the required directive does this to work out if the input has data or not. - * The default `$isEmpty` function checks whether the value is `undefined`, `''`, `null` or `NaN`. - * - * You can override this for input directives whose concept of being empty is different to the - * default. The `checkboxInputType` directive does this because in its case a value of `false` - * implies empty. - * - * @param {*} value Reference to check. - * @returns {boolean} True if `value` is empty. - */ - this.$isEmpty = function(value) { - return isUndefined(value) || value === '' || value === null || value !== value; - }; - - var parentForm = $element.inheritedData('$formController') || nullFormCtrl, - invalidCount = 0, // used to easily determine if we are valid - $error = this.$error = {}; // keep invalid keys here - - - // Setup initial state of the control - $element.addClass(PRISTINE_CLASS); - toggleValidCss(true); - - // convenience method for easy toggling of classes - function toggleValidCss(isValid, validationErrorKey) { - validationErrorKey = validationErrorKey ? '-' + snake_case(validationErrorKey, '-') : ''; - $animate.removeClass($element, (isValid ? INVALID_CLASS : VALID_CLASS) + validationErrorKey); - $animate.addClass($element, (isValid ? VALID_CLASS : INVALID_CLASS) + validationErrorKey); - } - - /** - * @ngdoc method - * @name ngModel.NgModelController#$setValidity - * - * @description - * Change the validity state, and notifies the form when the control changes validity. (i.e. it - * does not notify form if given validator is already marked as invalid). - * - * This method should be called by validators - i.e. the parser or formatter functions. - * - * @param {string} validationErrorKey Name of the validator. the `validationErrorKey` will assign - * to `$error[validationErrorKey]=isValid` so that it is available for data-binding. - * The `validationErrorKey` should be in camelCase and will get converted into dash-case - * for class name. Example: `myError` will result in `ng-valid-my-error` and `ng-invalid-my-error` - * class and can be bound to as `{{someForm.someControl.$error.myError}}` . - * @param {boolean} isValid Whether the current state is valid (true) or invalid (false). - */ - this.$setValidity = function(validationErrorKey, isValid) { - // Purposeful use of ! here to cast isValid to boolean in case it is undefined - // jshint -W018 - if ($error[validationErrorKey] === !isValid) return; - // jshint +W018 - - if (isValid) { - if ($error[validationErrorKey]) invalidCount--; - if (!invalidCount) { - toggleValidCss(true); - this.$valid = true; - this.$invalid = false; - } - } else { - toggleValidCss(false); - this.$invalid = true; - this.$valid = false; - invalidCount++; - } - - $error[validationErrorKey] = !isValid; - toggleValidCss(isValid, validationErrorKey); - - parentForm.$setValidity(validationErrorKey, isValid, this); - }; - - /** - * @ngdoc method - * @name ngModel.NgModelController#$setPristine - * - * @description - * Sets the control to its pristine state. - * - * This method can be called to remove the 'ng-dirty' class and set the control to its pristine - * state (ng-pristine class). - */ - this.$setPristine = function () { - this.$dirty = false; - this.$pristine = true; - $animate.removeClass($element, DIRTY_CLASS); - $animate.addClass($element, PRISTINE_CLASS); - }; - - /** - * @ngdoc method - * @name ngModel.NgModelController#$setViewValue - * - * @description - * Update the view value. - * - * This method should be called when the view value changes, typically from within a DOM event handler. - * For example {@link ng.directive:input input} and - * {@link ng.directive:select select} directives call it. - * - * It will update the $viewValue, then pass this value through each of the functions in `$parsers`, - * which includes any validators. The value that comes out of this `$parsers` pipeline, be applied to - * `$modelValue` and the **expression** specified in the `ng-model` attribute. - * - * Lastly, all the registered change listeners, in the `$viewChangeListeners` list, are called. - * - * Note that calling this function does not trigger a `$digest`. - * - * @param {string} value Value from the view. - */ - this.$setViewValue = function(value) { - this.$viewValue = value; - - // change to dirty - if (this.$pristine) { - this.$dirty = true; - this.$pristine = false; - $animate.removeClass($element, PRISTINE_CLASS); - $animate.addClass($element, DIRTY_CLASS); - parentForm.$setDirty(); - } - - forEach(this.$parsers, function(fn) { - value = fn(value); - }); - - if (this.$modelValue !== value) { - this.$modelValue = value; - ngModelSet($scope, value); - forEach(this.$viewChangeListeners, function(listener) { - try { - listener(); - } catch(e) { - $exceptionHandler(e); - } - }); - } - }; - - // model -> value - var ctrl = this; - - $scope.$watch(function ngModelWatch() { - var value = ngModelGet($scope); - - // if scope model value and ngModel value are out of sync - if (ctrl.$modelValue !== value) { - - var formatters = ctrl.$formatters, - idx = formatters.length; - - ctrl.$modelValue = value; - while(idx--) { - value = formatters[idx](value); - } - - if (ctrl.$viewValue !== value) { - ctrl.$viewValue = value; - ctrl.$render(); - } - } - - return value; - }); -}]; - - -/** - * @ngdoc directive - * @name ngModel - * - * @element input - * - * @description - * The `ngModel` directive binds an `input`,`select`, `textarea` (or custom form control) to a - * property on the scope using {@link ngModel.NgModelController NgModelController}, - * which is created and exposed by this directive. - * - * `ngModel` is responsible for: - * - * - Binding the view into the model, which other directives such as `input`, `textarea` or `select` - * require. - * - Providing validation behavior (i.e. required, number, email, url). - * - Keeping the state of the control (valid/invalid, dirty/pristine, validation errors). - * - Setting related css classes on the element (`ng-valid`, `ng-invalid`, `ng-dirty`, `ng-pristine`) including animations. - * - Registering the control with its parent {@link ng.directive:form form}. - * - * Note: `ngModel` will try to bind to the property given by evaluating the expression on the - * current scope. If the property doesn't already exist on this scope, it will be created - * implicitly and added to the scope. - * - * For best practices on using `ngModel`, see: - * - * - [https://github.com/angular/angular.js/wiki/Understanding-Scopes] - * - * For basic examples, how to use `ngModel`, see: - * - * - {@link ng.directive:input input} - * - {@link input[text] text} - * - {@link input[checkbox] checkbox} - * - {@link input[radio] radio} - * - {@link input[number] number} - * - {@link input[email] email} - * - {@link input[url] url} - * - {@link ng.directive:select select} - * - {@link ng.directive:textarea textarea} - * - * # CSS classes - * The following CSS classes are added and removed on the associated input/select/textarea element - * depending on the validity of the model. - * - * - `ng-valid` is set if the model is valid. - * - `ng-invalid` is set if the model is invalid. - * - `ng-pristine` is set if the model is pristine. - * - `ng-dirty` is set if the model is dirty. - * - * Keep in mind that ngAnimate can detect each of these classes when added and removed. - * - * ## Animation Hooks - * - * Animations within models are triggered when any of the associated CSS classes are added and removed - * on the input element which is attached to the model. These classes are: `.ng-pristine`, `.ng-dirty`, - * `.ng-invalid` and `.ng-valid` as well as any other validations that are performed on the model itself. - * The animations that are triggered within ngModel are similar to how they work in ngClass and - * animations can be hooked into using CSS transitions, keyframes as well as JS animations. - * - * The following example shows a simple way to utilize CSS transitions to style an input element - * that has been rendered as invalid after it has been validated: - * - * 
- * //be sure to include ngAnimate as a module to hook into more
- * //advanced animations
- * .my-input {
- *   transition:0.5s linear all;
- *   background: white;
- * }
- * .my-input.ng-invalid {
- *   background: red;
- *   color:white;
- * }
- *
- * - * @example - * - - - - Update input to see transitions when valid/invalid. - Integer is a valid value. -
- -
- - * - */ -var ngModelDirective = function() { - return { - require: ['ngModel', '^?form'], - controller: NgModelController, - link: function(scope, element, attr, ctrls) { - // notify others, especially parent forms - - var modelCtrl = ctrls[0], - formCtrl = ctrls[1] || nullFormCtrl; - - formCtrl.$addControl(modelCtrl); - - scope.$on('$destroy', function() { - formCtrl.$removeControl(modelCtrl); - }); - } - }; -}; - - -/** - * @ngdoc directive - * @name ngChange - * - * @description - * Evaluate the given expression when the user changes the input. - * The expression is evaluated immediately, unlike the JavaScript onchange event - * which only triggers at the end of a change (usually, when the user leaves the - * form element or presses the return key). - * The expression is not evaluated when the value change is coming from the model. - * - * Note, this directive requires `ngModel` to be present. - * - * @element input - * @param {expression} ngChange {@link guide/expression Expression} to evaluate upon change - * in input value. - * - * @example - * - * - * - *
- * - * - *
- * debug = {{confirmed}}
- * counter = {{counter}}
- *
- * - * - * var counter = element(by.binding('counter')); - * var debug = element(by.binding('confirmed')); - * - * it('should evaluate the expression if changing from view', function() { - * expect(counter.getText()).toContain('0'); - * - * element(by.id('ng-change-example1')).click(); - * - * expect(counter.getText()).toContain('1'); - * expect(debug.getText()).toContain('true'); - * }); - * - * it('should not evaluate the expression if changing from model', function() { - * element(by.id('ng-change-example2')).click(); - - * expect(counter.getText()).toContain('0'); - * expect(debug.getText()).toContain('true'); - * }); - * - * - */ -var ngChangeDirective = valueFn({ - require: 'ngModel', - link: function(scope, element, attr, ctrl) { - ctrl.$viewChangeListeners.push(function() { - scope.$eval(attr.ngChange); - }); - } -}); - - -var requiredDirective = function() { - return { - require: '?ngModel', - link: function(scope, elm, attr, ctrl) { - if (!ctrl) return; - attr.required = true; // force truthy in case we are on non input element - - var validator = function(value) { - if (attr.required && ctrl.$isEmpty(value)) { - ctrl.$setValidity('required', false); - return; - } else { - ctrl.$setValidity('required', true); - return value; - } - }; - - ctrl.$formatters.push(validator); - ctrl.$parsers.unshift(validator); - - attr.$observe('required', function() { - validator(ctrl.$viewValue); - }); - } - }; -}; - - -/** - * @ngdoc directive - * @name ngList - * - * @description - * Text input that converts between a delimited string and an array of strings. The delimiter - * can be a fixed string (by default a comma) or a regular expression. - * - * @element input - * @param {string=} ngList optional delimiter that should be used to split the value. If - * specified in form `/something/` then the value will be converted into a regular expression. - * - * @example - - - -
- List: - - Required! -
- names = {{names}}
- myForm.namesInput.$valid = {{myForm.namesInput.$valid}}
- myForm.namesInput.$error = {{myForm.namesInput.$error}}
- myForm.$valid = {{myForm.$valid}}
- myForm.$error.required = {{!!myForm.$error.required}}
-
- - - var listInput = element(by.model('names')); - var names = element(by.binding('{{names}}')); - var valid = element(by.binding('myForm.namesInput.$valid')); - var error = element(by.css('span.error')); - - it('should initialize to model', function() { - expect(names.getText()).toContain('["igor","misko","vojta"]'); - expect(valid.getText()).toContain('true'); - expect(error.getCssValue('display')).toBe('none'); - }); - - it('should be invalid if empty', function() { - listInput.clear(); - listInput.sendKeys(''); - - expect(names.getText()).toContain(''); - expect(valid.getText()).toContain('false'); - expect(error.getCssValue('display')).not.toBe('none'); }); - - - */ -var ngListDirective = function() { - return { - require: 'ngModel', - link: function(scope, element, attr, ctrl) { - var match = /\/(.*)\//.exec(attr.ngList), - separator = match && new RegExp(match[1]) || attr.ngList || ','; - - var parse = function(viewValue) { - // If the viewValue is invalid (say required but empty) it will be `undefined` - if (isUndefined(viewValue)) return; - - var list = []; - - if (viewValue) { - forEach(viewValue.split(separator), function(value) { - if (value) list.push(trim(value)); - }); - } - - return list; - }; - - ctrl.$parsers.push(parse); - ctrl.$formatters.push(function(value) { - if (isArray(value)) { - return value.join(', '); - } - - return undefined; - }); - - // Override the standard $isEmpty because an empty array means the input is empty. - ctrl.$isEmpty = function(value) { - return !value || !value.length; - }; - } - }; -}; - - -var CONSTANT_VALUE_REGEXP = /^(true|false|\d+)$/; -/** - * @ngdoc directive - * @name ngValue - * - * @description - * Binds the given expression to the value of `input[select]` or `input[radio]`, so - * that when the element is selected, the `ngModel` of that element is set to the - * bound value. - * - * `ngValue` is useful when dynamically generating lists of radio buttons using `ng-repeat`, as - * shown below. - * - * @element input - * @param {string=} ngValue angular expression, whose value will be bound to the `value` attribute - * of the `input` element - * - * @example - - - -
-

Which is your favorite?

- -
You chose {{my.favorite}}
-
- - - var favorite = element(by.binding('my.favorite')); - - it('should initialize to model', function() { - expect(favorite.getText()).toContain('unicorns'); - }); - it('should bind the values to the inputs', function() { - element.all(by.model('my.favorite')).get(0).click(); - expect(favorite.getText()).toContain('pizza'); - }); - - - */ -var ngValueDirective = function() { - return { - priority: 100, - compile: function(tpl, tplAttr) { - if (CONSTANT_VALUE_REGEXP.test(tplAttr.ngValue)) { - return function ngValueConstantLink(scope, elm, attr) { - attr.$set('value', scope.$eval(attr.ngValue)); - }; - } else { - return function ngValueLink(scope, elm, attr) { - scope.$watch(attr.ngValue, function valueWatchAction(value) { - attr.$set('value', value); - }); - }; - } - } - }; -}; - -/** - * @ngdoc directive - * @name ngBind - * @restrict AC - * - * @description - * The `ngBind` attribute tells Angular to replace the text content of the specified HTML element - * with the value of a given expression, and to update the text content when the value of that - * expression changes. - * - * Typically, you don't use `ngBind` directly, but instead you use the double curly markup like - * `{{ expression }}` which is similar but less verbose. - * - * It is preferable to use `ngBind` instead of `{{ expression }}` when a template is momentarily - * displayed by the browser in its raw state before Angular compiles it. Since `ngBind` is an - * element attribute, it makes the bindings invisible to the user while the page is loading. - * - * An alternative solution to this problem would be using the - * {@link ng.directive:ngCloak ngCloak} directive. - * - * - * @element ANY - * @param {expression} ngBind {@link guide/expression Expression} to evaluate. - * - * @example - * Enter a name in the Live Preview text box; the greeting below the text box changes instantly. - - - -
- Enter name:
- Hello ! -
- - - it('should check ng-bind', function() { - var nameInput = element(by.model('name')); - - expect(element(by.binding('name')).getText()).toBe('Whirled'); - nameInput.clear(); - nameInput.sendKeys('world'); - expect(element(by.binding('name')).getText()).toBe('world'); - }); - - - */ -var ngBindDirective = ngDirective(function(scope, element, attr) { - element.addClass('ng-binding').data('$binding', attr.ngBind); - scope.$watch(attr.ngBind, function ngBindWatchAction(value) { - // We are purposefully using == here rather than === because we want to - // catch when value is "null or undefined" - // jshint -W041 - element.text(value == undefined ? '' : value); - }); -}); - - -/** - * @ngdoc directive - * @name ngBindTemplate - * - * @description - * The `ngBindTemplate` directive specifies that the element - * text content should be replaced with the interpolation of the template - * in the `ngBindTemplate` attribute. - * Unlike `ngBind`, the `ngBindTemplate` can contain multiple `{{` `}}` - * expressions. This directive is needed since some HTML elements - * (such as TITLE and OPTION) cannot contain SPAN elements. - * - * @element ANY - * @param {string} ngBindTemplate template of form - * {{ expression }} to eval. - * - * @example - * Try it here: enter text in text box and watch the greeting change. - - - -
- Salutation:
- Name:
- 

-       

-     
-     
-       it('should check ng-bind', function() {
-         var salutationElem = element(by.binding('salutation'));
-         var salutationInput = element(by.model('salutation'));
-         var nameInput = element(by.model('name'));
-
-         expect(salutationElem.getText()).toBe('Hello World!');
-
-         salutationInput.clear();
-         salutationInput.sendKeys('Greetings');
-         nameInput.clear();
-         nameInput.sendKeys('user');
-
-         expect(salutationElem.getText()).toBe('Greetings user!');
-       });
-     
-   
- */
-var ngBindTemplateDirective = ['$interpolate', function($interpolate) {
-  return function(scope, element, attr) {
-    // TODO: move this to scenario runner
-    var interpolateFn = $interpolate(element.attr(attr.$attr.ngBindTemplate));
-    element.addClass('ng-binding').data('$binding', interpolateFn);
-    attr.$observe('ngBindTemplate', function(value) {
-      element.text(value);
-    });
-  };
-}];
-
-
-/**
- * @ngdoc directive
- * @name ngBindHtml
- *
- * @description
- * Creates a binding that will innerHTML the result of evaluating the `expression` into the current
- * element in a secure way.  By default, the innerHTML-ed content will be sanitized using the {@link
- * ngSanitize.$sanitize $sanitize} service.  To utilize this functionality, ensure that `$sanitize`
- * is available, for example, by including {@link ngSanitize} in your module's dependencies (not in
- * core Angular.)  You may also bypass sanitization for values you know are safe. To do so, bind to
- * an explicitly trusted value via {@link ng.$sce#trustAsHtml $sce.trustAsHtml}.  See the example
- * under {@link ng.$sce#Example Strict Contextual Escaping (SCE)}.
- *
- * Note: If a `$sanitize` service is unavailable and the bound value isn't explicitly trusted, you
- * will have an exception (instead of an exploit.)
- *
- * @element ANY
- * @param {expression} ngBindHtml {@link guide/expression Expression} to evaluate.
- *
- * @example
-   Try it here: enter text in text box and watch the greeting change.
-
-   
-     
-       

-        

-       

-     
-
-     
-       angular.module('ngBindHtmlExample', ['ngSanitize'])
-
-       .controller('ngBindHtmlCtrl', ['$scope', function ngBindHtmlCtrl($scope) {
-         $scope.myHTML =
-            'I am an HTMLstring with links! and other stuff';
-       }]);
-     
-
-     
-       it('should check ng-bind-html', function() {
-         expect(element(by.binding('myHTML')).getText()).toBe(
-             'I am an HTMLstring with links! and other stuff');
-       });
-     
-   
- */
-var ngBindHtmlDirective = ['$sce', '$parse', function($sce, $parse) {
-  return function(scope, element, attr) {
-    element.addClass('ng-binding').data('$binding', attr.ngBindHtml);
-
-    var parsed = $parse(attr.ngBindHtml);
-    function getStringValue() { return (parsed(scope) || '').toString(); }
-
-    scope.$watch(getStringValue, function ngBindHtmlWatchAction(value) {
-      element.html($sce.getTrustedHtml(parsed(scope)) || '');
-    });
-  };
-}];
-
-function classDirective(name, selector) {
-  name = 'ngClass' + name;
-  return ['$animate', function($animate) {
-    return {
-      restrict: 'AC',
-      link: function(scope, element, attr) {
-        var oldVal;
-
-        scope.$watch(attr[name], ngClassWatchAction, true);
-
-        attr.$observe('class', function(value) {
-          ngClassWatchAction(scope.$eval(attr[name]));
-        });
-
-
-        if (name !== 'ngClass') {
-          scope.$watch('$index', function($index, old$index) {
-            // jshint bitwise: false
-            var mod = $index & 1;
-            if (mod !== old$index & 1) {
-              var classes = arrayClasses(scope.$eval(attr[name]));
-              mod === selector ?
-                addClasses(classes) :
-                removeClasses(classes);
-            }
-          });
-        }
-
-        function addClasses(classes) {
-          var newClasses = digestClassCounts(classes, 1);
-          attr.$addClass(newClasses);
-        }
-
-        function removeClasses(classes) {
-          var newClasses = digestClassCounts(classes, -1);
-          attr.$removeClass(newClasses);
-        }
-
-        function digestClassCounts (classes, count) {
-          var classCounts = element.data('$classCounts') || {};
-          var classesToUpdate = [];
-          forEach(classes, function (className) {
-            if (count > 0 || classCounts[className]) {
-              classCounts[className] = (classCounts[className] || 0) + count;
-              if (classCounts[className] === +(count > 0)) {
-                classesToUpdate.push(className);
-              }
-            }
-          });
-          element.data('$classCounts', classCounts);
-          return classesToUpdate.join(' ');
-        }
-
-        function updateClasses (oldClasses, newClasses) {
-          var toAdd = arrayDifference(newClasses, oldClasses);
-          var toRemove = arrayDifference(oldClasses, newClasses);
-          toRemove = digestClassCounts(toRemove, -1);
-          toAdd = digestClassCounts(toAdd, 1);
-
-          if (toAdd.length === 0) {
-            $animate.removeClass(element, toRemove);
-          } else if (toRemove.length === 0) {
-            $animate.addClass(element, toAdd);
-          } else {
-            $animate.setClass(element, toAdd, toRemove);
-          }
-        }
-
-        function ngClassWatchAction(newVal) {
-          if (selector === true || scope.$index % 2 === selector) {
-            var newClasses = arrayClasses(newVal || []);
-            if (!oldVal) {
-              addClasses(newClasses);
-            } else if (!equals(newVal,oldVal)) {
-              var oldClasses = arrayClasses(oldVal);
-              updateClasses(oldClasses, newClasses);
-            }
-          }
-          oldVal = copy(newVal);
-        }
-      }
-    };
-
-    function arrayDifference(tokens1, tokens2) {
-      var values = [];
-
-      outer:
-      for(var i = 0; i < tokens1.length; i++) {
-        var token = tokens1[i];
-        for(var j = 0; j < tokens2.length; j++) {
-          if(token == tokens2[j]) continue outer;
-        }
-        values.push(token);
-      }
-      return values;
-    }
-
-    function arrayClasses (classVal) {
-      if (isArray(classVal)) {
-        return classVal;
-      } else if (isString(classVal)) {
-        return classVal.split(' ');
-      } else if (isObject(classVal)) {
-        var classes = [], i = 0;
-        forEach(classVal, function(v, k) {
-          if (v) {
-            classes.push(k);
-          }
-        });
-        return classes;
-      }
-      return classVal;
-    }
-  }];
-}
-
-/**
- * @ngdoc directive
- * @name ngClass
- * @restrict AC
- *
- * @description
- * The `ngClass` directive allows you to dynamically set CSS classes on an HTML element by databinding
- * an expression that represents all classes to be added.
- *
- * The directive operates in three different ways, depending on which of three types the expression
- * evaluates to:
- *
- * 1. If the expression evaluates to a string, the string should be one or more space-delimited class
- * names.
- *
- * 2. If the expression evaluates to an array, each element of the array should be a string that is
- * one or more space-delimited class names.
- *
- * 3. If the expression evaluates to an object, then for each key-value pair of the
- * object with a truthy value the corresponding key is used as a class name.
- *
- * The directive won't add duplicate classes if a particular class was already set.
- *
- * When the expression changes, the previously added classes are removed and only then the
- * new classes are added.
- *
- * @animations
- * add - happens just before the class is applied to the element
- * remove - happens just before the class is removed from the element
- *
- * @element ANY
- * @param {expression} ngClass {@link guide/expression Expression} to eval. The result
- *   of the evaluation can be a string representing space delimited class
- *   names, an array, or a map of class names to boolean values. In the case of a map, the
- *   names of the properties whose values are truthy will be added as css classes to the
- *   element.
- *
- * @example Example that demonstrates basic bindings via ngClass directive.
-   
-     
-       
Map Syntax Example

-        deleted (apply "strike" class)

-        important (apply "bold" class)

-        error (apply "red" class)
-       

-       
Using String Syntax

-       
-       

-       
Using Array Syntax

-       

-       

-       

-     
-     
-       .strike {
-         text-decoration: line-through;
-       }
-       .bold {
-           font-weight: bold;
-       }
-       .red {
-           color: red;
-       }
-     
-     
-       var ps = element.all(by.css('p'));
-
-       it('should let you toggle the class', function() {
-
-         expect(ps.first().getAttribute('class')).not.toMatch(/bold/);
-         expect(ps.first().getAttribute('class')).not.toMatch(/red/);
-
-         element(by.model('important')).click();
-         expect(ps.first().getAttribute('class')).toMatch(/bold/);
-
-         element(by.model('error')).click();
-         expect(ps.first().getAttribute('class')).toMatch(/red/);
-       });
-
-       it('should let you toggle string example', function() {
-         expect(ps.get(1).getAttribute('class')).toBe('');
-         element(by.model('style')).clear();
-         element(by.model('style')).sendKeys('red');
-         expect(ps.get(1).getAttribute('class')).toBe('red');
-       });
-
-       it('array example should have 3 classes', function() {
-         expect(ps.last().getAttribute('class')).toBe('');
-         element(by.model('style1')).sendKeys('bold');
-         element(by.model('style2')).sendKeys('strike');
-         element(by.model('style3')).sendKeys('red');
-         expect(ps.last().getAttribute('class')).toBe('bold strike red');
-       });
-     
-   
-
-   ## Animations
-
-   The example below demonstrates how to perform animations using ngClass.
-
-   
-     
-      
-      
-      

-      Sample Text
-     
-     
-       .base-class {
-         -webkit-transition:all cubic-bezier(0.250, 0.460, 0.450, 0.940) 0.5s;
-         transition:all cubic-bezier(0.250, 0.460, 0.450, 0.940) 0.5s;
-       }
-
-       .base-class.my-class {
-         color: red;
-         font-size:3em;
-       }
-     
-     
-       it('should check ng-class', function() {
-         expect(element(by.css('.base-class')).getAttribute('class')).not.
-           toMatch(/my-class/);
-
-         element(by.id('setbtn')).click();
-
-         expect(element(by.css('.base-class')).getAttribute('class')).
-           toMatch(/my-class/);
-
-         element(by.id('clearbtn')).click();
-
-         expect(element(by.css('.base-class')).getAttribute('class')).not.
-           toMatch(/my-class/);
-       });
-     
-   
-
-
-   ## ngClass and pre-existing CSS3 Transitions/Animations
-   The ngClass directive still supports CSS3 Transitions/Animations even if they do not follow the ngAnimate CSS naming structure.
-   Upon animation ngAnimate will apply supplementary CSS classes to track the start and end of an animation, but this will not hinder
-   any pre-existing CSS transitions already on the element. To get an idea of what happens during a class-based animation, be sure
-   to view the step by step details of {@link ngAnimate.$animate#addclass $animate.addClass} and
-   {@link ngAnimate.$animate#removeclass $animate.removeClass}.
- */
-var ngClassDirective = classDirective('', true);
-
-/**
- * @ngdoc directive
- * @name ngClassOdd
- * @restrict AC
- *
- * @description
- * The `ngClassOdd` and `ngClassEven` directives work exactly as
- * {@link ng.directive:ngClass ngClass}, except they work in
- * conjunction with `ngRepeat` and take effect only on odd (even) rows.
- *
- * This directive can be applied only within the scope of an
- * {@link ng.directive:ngRepeat ngRepeat}.
- *
- * @element ANY
- * @param {expression} ngClassOdd {@link guide/expression Expression} to eval. The result
- *   of the evaluation can be a string representing space delimited class names or an array.
- *
- * @example
-   
-     
-        
    
-          
  1. 
-           
-             {{name}}
-           
-          
    2. 
-        

-     
-     
-       .odd {
-         color: red;
-       }
-       .even {
-         color: blue;
-       }
-     
-     
-       it('should check ng-class-odd and ng-class-even', function() {
-         expect(element(by.repeater('name in names').row(0).column('name')).getAttribute('class')).
-           toMatch(/odd/);
-         expect(element(by.repeater('name in names').row(1).column('name')).getAttribute('class')).
-           toMatch(/even/);
-       });
-     
-   
- */
-var ngClassOddDirective = classDirective('Odd', 0);
-
-/**
- * @ngdoc directive
- * @name ngClassEven
- * @restrict AC
- *
- * @description
- * The `ngClassOdd` and `ngClassEven` directives work exactly as
- * {@link ng.directive:ngClass ngClass}, except they work in
- * conjunction with `ngRepeat` and take effect only on odd (even) rows.
- *
- * This directive can be applied only within the scope of an
- * {@link ng.directive:ngRepeat ngRepeat}.
- *
- * @element ANY
- * @param {expression} ngClassEven {@link guide/expression Expression} to eval. The
- *   result of the evaluation can be a string representing space delimited class names or an array.
- *
- * @example
-   
-     
-        
    
-          
  1. 
-           
-             {{name}}      
-           
-          
    2. 
-        

-     
-     
-       .odd {
-         color: red;
-       }
-       .even {
-         color: blue;
-       }
-     
-     
-       it('should check ng-class-odd and ng-class-even', function() {
-         expect(element(by.repeater('name in names').row(0).column('name')).getAttribute('class')).
-           toMatch(/odd/);
-         expect(element(by.repeater('name in names').row(1).column('name')).getAttribute('class')).
-           toMatch(/even/);
-       });
-     
-   
- */
-var ngClassEvenDirective = classDirective('Even', 1);
-
-/**
- * @ngdoc directive
- * @name ngCloak
- * @restrict AC
- *
- * @description
- * The `ngCloak` directive is used to prevent the Angular html template from being briefly
- * displayed by the browser in its raw (uncompiled) form while your application is loading. Use this
- * directive to avoid the undesirable flicker effect caused by the html template display.
- *
- * The directive can be applied to the `` element, but the preferred usage is to apply
- * multiple `ngCloak` directives to small portions of the page to permit progressive rendering
- * of the browser view.
- *
- * `ngCloak` works in cooperation with the following css rule embedded within `angular.js` and
- * `angular.min.js`.
- * For CSP mode please add `angular-csp.css` to your html file (see {@link ng.directive:ngCsp ngCsp}).
- *
- * ```css
- * [ng\:cloak], [ng-cloak], [data-ng-cloak], [x-ng-cloak], .ng-cloak, .x-ng-cloak {
- *   display: none !important;
- * }
- * ```
- *
- * When this css rule is loaded by the browser, all html elements (including their children) that
- * are tagged with the `ngCloak` directive are hidden. When Angular encounters this directive
- * during the compilation of the template it deletes the `ngCloak` element attribute, making
- * the compiled element visible.
- *
- * For the best result, the `angular.js` script must be loaded in the head section of the html
- * document; alternatively, the css rule above must be included in the external stylesheet of the
- * application.
- *
- * Legacy browsers, like IE7, do not provide attribute selector support (added in CSS 2.1) so they
- * cannot match the `[ng\:cloak]` selector. To work around this limitation, you must add the css
- * class `ng-cloak` in addition to the `ngCloak` directive as shown in the example below.
- *
- * @element ANY
- *
- * @example
-   
-     
-        
{{ 'hello' }}

-        
{{ 'hello IE7' }}

-     
-     
-       it('should remove the template directive and css class', function() {
-         expect($('#template1').getAttribute('ng-cloak')).
-           toBeNull();
-         expect($('#template2').getAttribute('ng-cloak')).
-           toBeNull();
-       });
-     
-   
- *
- */
-var ngCloakDirective = ngDirective({
-  compile: function(element, attr) {
-    attr.$set('ngCloak', undefined);
-    element.removeClass('ng-cloak');
-  }
-});
-
-/**
- * @ngdoc directive
- * @name ngController
- *
- * @description
- * The `ngController` directive attaches a controller class to the view. This is a key aspect of how angular
- * supports the principles behind the Model-View-Controller design pattern.
- *
- * MVC components in angular:
- *
- * * Model — The Model is scope properties; scopes are attached to the DOM where scope properties
- *   are accessed through bindings.
- * * View — The template (HTML with data bindings) that is rendered into the View.
- * * Controller — The `ngController` directive specifies a Controller class; the class contains business
- *   logic behind the application to decorate the scope with functions and values
- *
- * Note that you can also attach controllers to the DOM by declaring it in a route definition
- * via the {@link ngRoute.$route $route} service. A common mistake is to declare the controller
- * again using `ng-controller` in the template itself.  This will cause the controller to be attached
- * and executed twice.
- *
- * @element ANY
- * @scope
- * @param {expression} ngController Name of a globally accessible constructor function or an
- *     {@link guide/expression expression} that on the current scope evaluates to a
- *     constructor function. The controller instance can be published into a scope property
- *     by specifying `as propertyName`.
- *
- * @example
- * Here is a simple form for editing user contact information. Adding, removing, clearing, and
- * greeting are methods declared on the controller (see source tab). These methods can
- * easily be called from the angular markup. Notice that the scope becomes the `this` for the
- * controller's instance. This allows for easy access to the view data from the controller. Also
- * notice that any changes to the data are automatically reflected in the View without the need
- * for a manual update. The example is shown in two different declaration styles you may use
- * according to preference.
-   
-     
-      
-      

-        Name: 
-        [ greet ]

-        Contact:
-        
    
-          
  • 
-            
-            
-            [ clear
-            | X ]
-          
    • 
-          
  • [ add ]
    • 
-       

-      

-     
-     
-       it('should check controller as', function() {
-         var container = element(by.id('ctrl-as-exmpl'));
-
-         expect(container.findElement(by.model('settings.name'))
-             .getAttribute('value')).toBe('John Smith');
-
-         var firstRepeat =
-             container.findElement(by.repeater('contact in settings.contacts').row(0));
-         var secondRepeat =
-             container.findElement(by.repeater('contact in settings.contacts').row(1));
-
-         expect(firstRepeat.findElement(by.model('contact.value')).getAttribute('value'))
-             .toBe('408 555 1212');
-         expect(secondRepeat.findElement(by.model('contact.value')).getAttribute('value'))
-             .toBe('john.smith@example.org');
-
-         firstRepeat.findElement(by.linkText('clear')).click();
-
-         expect(firstRepeat.findElement(by.model('contact.value')).getAttribute('value'))
-             .toBe('');
-
-         container.findElement(by.linkText('add')).click();
-
-         expect(container.findElement(by.repeater('contact in settings.contacts').row(2))
-             .findElement(by.model('contact.value'))
-             .getAttribute('value'))
-             .toBe('yourname@example.org');
-       });
-     
-   
-    
-     
-      
-      

-        Name: 
-        [ greet ]

-        Contact:
-        
    
-          
  • 
-            
-            
-            [ clear
-            | X ]
-          
    • 
-          
  • [ add ]
    • 
-       

-      

-     
-     
-       it('should check controller', function() {
-         var container = element(by.id('ctrl-exmpl'));
-
-         expect(container.findElement(by.model('name'))
-             .getAttribute('value')).toBe('John Smith');
-
-         var firstRepeat =
-             container.findElement(by.repeater('contact in contacts').row(0));
-         var secondRepeat =
-             container.findElement(by.repeater('contact in contacts').row(1));
-
-         expect(firstRepeat.findElement(by.model('contact.value')).getAttribute('value'))
-             .toBe('408 555 1212');
-         expect(secondRepeat.findElement(by.model('contact.value')).getAttribute('value'))
-             .toBe('john.smith@example.org');
-
-         firstRepeat.findElement(by.linkText('clear')).click();
-
-         expect(firstRepeat.findElement(by.model('contact.value')).getAttribute('value'))
-             .toBe('');
-
-         container.findElement(by.linkText('add')).click();
-
-         expect(container.findElement(by.repeater('contact in contacts').row(2))
-             .findElement(by.model('contact.value'))
-             .getAttribute('value'))
-             .toBe('yourname@example.org');
-       });
-     
-   
-
- */
-var ngControllerDirective = [function() {
-  return {
-    scope: true,
-    controller: '@',
-    priority: 500
-  };
-}];
-
-/**
- * @ngdoc directive
- * @name ngCsp
- *
- * @element html
- * @description
- * Enables [CSP (Content Security Policy)](https://developer.mozilla.org/en/Security/CSP) support.
- *
- * This is necessary when developing things like Google Chrome Extensions.
- *
- * CSP forbids apps to use `eval` or `Function(string)` generated functions (among other things).
- * For us to be compatible, we just need to implement the "getterFn" in $parse without violating
- * any of these restrictions.
- *
- * AngularJS uses `Function(string)` generated functions as a speed optimization. Applying the `ngCsp`
- * directive will cause Angular to use CSP compatibility mode. When this mode is on AngularJS will
- * evaluate all expressions up to 30% slower than in non-CSP mode, but no security violations will
- * be raised.
- *
- * CSP forbids JavaScript to inline stylesheet rules. In non CSP mode Angular automatically
- * includes some CSS rules (e.g. {@link ng.directive:ngCloak ngCloak}).
- * To make those directives work in CSP mode, include the `angular-csp.css` manually.
- *
- * In order to use this feature put the `ngCsp` directive on the root element of the application.
- *
- * *Note: This directive is only available in the `ng-csp` and `data-ng-csp` attribute form.*
- *
- * @example
- * This example shows how to apply the `ngCsp` directive to the `html` tag.
-   ```html
-     
-     
-     ...
-     ...
-     
-   ```
- */
-
-// ngCsp is not implemented as a proper directive any more, because we need it be processed while we bootstrap
-// the system (before $parse is instantiated), for this reason we just have a csp() fn that looks for ng-csp attribute
-// anywhere in the current doc
-
-/**
- * @ngdoc directive
- * @name ngClick
- *
- * @description
- * The ngClick directive allows you to specify custom behavior when
- * an element is clicked.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngClick {@link guide/expression Expression} to evaluate upon
- * click. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      count: {{count}}
-     
-     
-       it('should check ng-click', function() {
-         expect(element(by.binding('count')).getText()).toMatch('0');
-         element(by.css('button')).click();
-         expect(element(by.binding('count')).getText()).toMatch('1');
-       });
-     
-   
- */
-/*
- * A directive that allows creation of custom onclick handlers that are defined as angular
- * expressions and are compiled and executed within the current scope.
- *
- * Events that are handled via these handler are always configured not to propagate further.
- */
-var ngEventDirectives = {};
-forEach(
-  'click dblclick mousedown mouseup mouseover mouseout mousemove mouseenter mouseleave keydown keyup keypress submit focus blur copy cut paste'.split(' '),
-  function(name) {
-    var directiveName = directiveNormalize('ng-' + name);
-    ngEventDirectives[directiveName] = ['$parse', function($parse) {
-      return {
-        compile: function($element, attr) {
-          var fn = $parse(attr[directiveName]);
-          return function(scope, element, attr) {
-            element.on(lowercase(name), function(event) {
-              scope.$apply(function() {
-                fn(scope, {$event:event});
-              });
-            });
-          };
-        }
-      };
-    }];
-  }
-);
-
-/**
- * @ngdoc directive
- * @name ngDblclick
- *
- * @description
- * The `ngDblclick` directive allows you to specify custom behavior on a dblclick event.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngDblclick {@link guide/expression Expression} to evaluate upon
- * a dblclick. (The Event object is available as `$event`)
- *
- * @example
-   
-     
-      
-      count: {{count}}
-     
-   
- */
-
-
-/**
- * @ngdoc directive
- * @name ngMousedown
- *
- * @description
- * The ngMousedown directive allows you to specify custom behavior on mousedown event.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngMousedown {@link guide/expression Expression} to evaluate upon
- * mousedown. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      count: {{count}}
-     
-   
- */
-
-
-/**
- * @ngdoc directive
- * @name ngMouseup
- *
- * @description
- * Specify custom behavior on mouseup event.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngMouseup {@link guide/expression Expression} to evaluate upon
- * mouseup. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      count: {{count}}
-     
-   
- */
-
-/**
- * @ngdoc directive
- * @name ngMouseover
- *
- * @description
- * Specify custom behavior on mouseover event.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngMouseover {@link guide/expression Expression} to evaluate upon
- * mouseover. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      count: {{count}}
-     
-   
- */
-
-
-/**
- * @ngdoc directive
- * @name ngMouseenter
- *
- * @description
- * Specify custom behavior on mouseenter event.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngMouseenter {@link guide/expression Expression} to evaluate upon
- * mouseenter. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      count: {{count}}
-     
-   
- */
-
-
-/**
- * @ngdoc directive
- * @name ngMouseleave
- *
- * @description
- * Specify custom behavior on mouseleave event.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngMouseleave {@link guide/expression Expression} to evaluate upon
- * mouseleave. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      count: {{count}}
-     
-   
- */
-
-
-/**
- * @ngdoc directive
- * @name ngMousemove
- *
- * @description
- * Specify custom behavior on mousemove event.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngMousemove {@link guide/expression Expression} to evaluate upon
- * mousemove. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      count: {{count}}
-     
-   
- */
-
-
-/**
- * @ngdoc directive
- * @name ngKeydown
- *
- * @description
- * Specify custom behavior on keydown event.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngKeydown {@link guide/expression Expression} to evaluate upon
- * keydown. (Event object is available as `$event` and can be interrogated for keyCode, altKey, etc.)
- *
- * @example
-   
-     
-      
-      key down count: {{count}}
-     
-   
- */
-
-
-/**
- * @ngdoc directive
- * @name ngKeyup
- *
- * @description
- * Specify custom behavior on keyup event.
- *
- * @element ANY
- * @priority 0
- * @param {expression} ngKeyup {@link guide/expression Expression} to evaluate upon
- * keyup. (Event object is available as `$event` and can be interrogated for keyCode, altKey, etc.)
- *
- * @example
-   
-     
-      
-      key up count: {{count}}
-     
-   
- */
-
-
-/**
- * @ngdoc directive
- * @name ngKeypress
- *
- * @description
- * Specify custom behavior on keypress event.
- *
- * @element ANY
- * @param {expression} ngKeypress {@link guide/expression Expression} to evaluate upon
- * keypress. ({@link guide/expression#-event- Event object is available as `$event`}
- * and can be interrogated for keyCode, altKey, etc.)
- *
- * @example
-   
-     
-      
-      key press count: {{count}}
-     
-   
- */
-
-
-/**
- * @ngdoc directive
- * @name ngSubmit
- *
- * @description
- * Enables binding angular expressions to onsubmit events.
- *
- * Additionally it prevents the default action (which for form means sending the request to the
- * server and reloading the current page), but only if the form does not contain `action`,
- * `data-action`, or `x-action` attributes.
- *
- * @element form
- * @priority 0
- * @param {expression} ngSubmit {@link guide/expression Expression} to eval.
- * ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      

-        Enter text and hit enter:
-        
-        
-        
list={{list}}

-      

-     
-     
-       it('should check ng-submit', function() {
-         expect(element(by.binding('list')).getText()).toBe('list=[]');
-         element(by.css('#submit')).click();
-         expect(element(by.binding('list')).getText()).toContain('hello');
-         expect(element(by.input('text')).getAttribute('value')).toBe('');
-       });
-       it('should ignore empty strings', function() {
-         expect(element(by.binding('list')).getText()).toBe('list=[]');
-         element(by.css('#submit')).click();
-         element(by.css('#submit')).click();
-         expect(element(by.binding('list')).getText()).toContain('hello');
-        });
-     
-   
- */
-
-/**
- * @ngdoc directive
- * @name ngFocus
- *
- * @description
- * Specify custom behavior on focus event.
- *
- * @element window, input, select, textarea, a
- * @priority 0
- * @param {expression} ngFocus {@link guide/expression Expression} to evaluate upon
- * focus. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
- * See {@link ng.directive:ngClick ngClick}
- */
-
-/**
- * @ngdoc directive
- * @name ngBlur
- *
- * @description
- * Specify custom behavior on blur event.
- *
- * @element window, input, select, textarea, a
- * @priority 0
- * @param {expression} ngBlur {@link guide/expression Expression} to evaluate upon
- * blur. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
- * See {@link ng.directive:ngClick ngClick}
- */
-
-/**
- * @ngdoc directive
- * @name ngCopy
- *
- * @description
- * Specify custom behavior on copy event.
- *
- * @element window, input, select, textarea, a
- * @priority 0
- * @param {expression} ngCopy {@link guide/expression Expression} to evaluate upon
- * copy. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      copied: {{copied}}
-     
-   
- */
-
-/**
- * @ngdoc directive
- * @name ngCut
- *
- * @description
- * Specify custom behavior on cut event.
- *
- * @element window, input, select, textarea, a
- * @priority 0
- * @param {expression} ngCut {@link guide/expression Expression} to evaluate upon
- * cut. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      cut: {{cut}}
-     
-   
- */
-
-/**
- * @ngdoc directive
- * @name ngPaste
- *
- * @description
- * Specify custom behavior on paste event.
- *
- * @element window, input, select, textarea, a
- * @priority 0
- * @param {expression} ngPaste {@link guide/expression Expression} to evaluate upon
- * paste. ({@link guide/expression#-event- Event object is available as `$event`})
- *
- * @example
-   
-     
-      
-      pasted: {{paste}}
-     
-   
- */
-
-/**
- * @ngdoc directive
- * @name ngIf
- * @restrict A
- *
- * @description
- * The `ngIf` directive removes or recreates a portion of the DOM tree based on an
- * {expression}. If the expression assigned to `ngIf` evaluates to a false
- * value then the element is removed from the DOM, otherwise a clone of the
- * element is reinserted into the DOM.
- *
- * `ngIf` differs from `ngShow` and `ngHide` in that `ngIf` completely removes and recreates the
- * element in the DOM rather than changing its visibility via the `display` css property.  A common
- * case when this difference is significant is when using css selectors that rely on an element's
- * position within the DOM, such as the `:first-child` or `:last-child` pseudo-classes.
- *
- * Note that when an element is removed using `ngIf` its scope is destroyed and a new scope
- * is created when the element is restored.  The scope created within `ngIf` inherits from
- * its parent scope using
- * [prototypal inheritance](https://github.com/angular/angular.js/wiki/The-Nuances-of-Scope-Prototypal-Inheritance).
- * An important implication of this is if `ngModel` is used within `ngIf` to bind to
- * a javascript primitive defined in the parent scope. In this case any modifications made to the
- * variable within the child scope will override (hide) the value in the parent scope.
- *
- * Also, `ngIf` recreates elements using their compiled state. An example of this behavior
- * is if an element's class attribute is directly modified after it's compiled, using something like
- * jQuery's `.addClass()` method, and the element is later removed. When `ngIf` recreates the element
- * the added class will be lost because the original compiled state is used to regenerate the element.
- *
- * Additionally, you can provide animations via the `ngAnimate` module to animate the `enter`
- * and `leave` effects.
- *
- * @animations
- * enter - happens just after the ngIf contents change and a new DOM element is created and injected into the ngIf container
- * leave - happens just before the ngIf contents are removed from the DOM
- *
- * @element ANY
- * @scope
- * @priority 600
- * @param {expression} ngIf If the {@link guide/expression expression} is falsy then
- *     the element is removed from the DOM tree. If it is truthy a copy of the compiled
- *     element is added to the DOM tree.
- *
- * @example
-  
-    
-      Click me: 

-      Show when checked:
-      
-        I'm removed when the checkbox is unchecked.
-      
-    
-    
-      .animate-if {
-        background:white;
-        border:1px solid black;
-        padding:10px;
-      }
-
-      .animate-if.ng-enter, .animate-if.ng-leave {
-        -webkit-transition:all cubic-bezier(0.250, 0.460, 0.450, 0.940) 0.5s;
-        transition:all cubic-bezier(0.250, 0.460, 0.450, 0.940) 0.5s;
-      }
-
-      .animate-if.ng-enter,
-      .animate-if.ng-leave.ng-leave-active {
-        opacity:0;
-      }
-
-      .animate-if.ng-leave,
-      .animate-if.ng-enter.ng-enter-active {
-        opacity:1;
-      }
-    
-  
- */
-var ngIfDirective = ['$animate', function($animate) {
-  return {
-    transclude: 'element',
-    priority: 600,
-    terminal: true,
-    restrict: 'A',
-    $$tlb: true,
-    link: function ($scope, $element, $attr, ctrl, $transclude) {
-        var block, childScope, previousElements;
-        $scope.$watch($attr.ngIf, function ngIfWatchAction(value) {
-
-          if (toBoolean(value)) {
-            if (!childScope) {
-              childScope = $scope.$new();
-              $transclude(childScope, function (clone) {
-                clone[clone.length++] = document.createComment(' end ngIf: ' + $attr.ngIf + ' ');
-                // Note: We only need the first/last node of the cloned nodes.
-                // However, we need to keep the reference to the jqlite wrapper as it might be changed later
-                // by a directive with templateUrl when it's template arrives.
-                block = {
-                  clone: clone
-                };
-                $animate.enter(clone, $element.parent(), $element);
-              });
-            }
-          } else {
-            if(previousElements) {
-              previousElements.remove();
-              previousElements = null;
-            }
-            if(childScope) {
-              childScope.$destroy();
-              childScope = null;
-            }
-            if(block) {
-              previousElements = getBlockElements(block.clone);
-              $animate.leave(previousElements, function() {
-                previousElements = null;
-              });
-              block = null;
-            }
-          }
-        });
-    }
-  };
-}];
-
-/**
- * @ngdoc directive
- * @name ngInclude
- * @restrict ECA
- *
- * @description
- * Fetches, compiles and includes an external HTML fragment.
- *
- * By default, the template URL is restricted to the same domain and protocol as the
- * application document. This is done by calling {@link ng.$sce#getTrustedResourceUrl
- * $sce.getTrustedResourceUrl} on it. To load templates from other domains or protocols
- * you may either {@link ng.$sceDelegateProvider#resourceUrlWhitelist whitelist them} or
- * [wrap them](ng.$sce#trustAsResourceUrl) as trusted values. Refer to Angular's {@link
- * ng.$sce Strict Contextual Escaping}.
- *
- * In addition, the browser's
- * [Same Origin Policy](https://code.google.com/p/browsersec/wiki/Part2#Same-origin_policy_for_XMLHttpRequest)
- * and [Cross-Origin Resource Sharing (CORS)](http://www.w3.org/TR/cors/)
- * policy may further restrict whether the template is successfully loaded.
- * For example, `ngInclude` won't work for cross-domain requests on all browsers and for `file://`
- * access on some browsers.
- *
- * @animations
- * enter - animation is used to bring new content into the browser.
- * leave - animation is used to animate existing content away.
- *
- * The enter and leave animation occur concurrently.
- *
- * @scope
- * @priority 400
- *
- * @param {string} ngInclude|src angular expression evaluating to URL. If the source is a string constant,
- *                 make sure you wrap it in **single** quotes, e.g. `src="'myPartialTemplate.html'"`.
- * @param {string=} onload Expression to evaluate when a new partial is loaded.
- *
- * @param {string=} autoscroll Whether `ngInclude` should call {@link ng.$anchorScroll
- *                  $anchorScroll} to scroll the viewport after the content is loaded.
- *
- *                  - If the attribute is not set, disable scrolling.
- *                  - If the attribute is set without value, enable scrolling.
- *                  - Otherwise enable scrolling only if the expression evaluates to truthy value.
- *
- * @example
-  
-    
-     

-       
-       url of the template: {{template.url}}
-       

-       

-         

-       

-     

-    
-    
-      function Ctrl($scope) {
-        $scope.templates =
-          [ { name: 'template1.html', url: 'template1.html'},
-            { name: 'template2.html', url: 'template2.html'} ];
-        $scope.template = $scope.templates[0];
-      }
-     
-    
-      Content of template1.html
-    
-    
-      Content of template2.html
-    
-    
-      .slide-animate-container {
-        position:relative;
-        background:white;
-        border:1px solid black;
-        height:40px;
-        overflow:hidden;
-      }
-
-      .slide-animate {
-        padding:10px;
-      }
-
-      .slide-animate.ng-enter, .slide-animate.ng-leave {
-        -webkit-transition:all cubic-bezier(0.250, 0.460, 0.450, 0.940) 0.5s;
-        transition:all cubic-bezier(0.250, 0.460, 0.450, 0.940) 0.5s;
-
-        position:absolute;
-        top:0;
-        left:0;
-        right:0;
-        bottom:0;
-        display:block;
-        padding:10px;
-      }
-
-      .slide-animate.ng-enter {
-        top:-50px;
-      }
-      .slide-animate.ng-enter.ng-enter-active {
-        top:0;
-      }
-
-      .slide-animate.ng-leave {
-        top:0;
-      }
-      .slide-animate.ng-leave.ng-leave-active {
-        top:50px;
-      }
-    
-    
-      var templateSelect = element(by.model('template'));
-      var includeElem = element(by.css('[ng-include]'));
-
-      it('should load template1.html', function() {
-        expect(includeElem.getText()).toMatch(/Content of template1.html/);
-      });
-
-      it('should load template2.html', function() {
-        if (browser.params.browser == 'firefox') {
-          // Firefox can't handle using selects
-          // See https://github.com/angular/protractor/issues/480
-          return;
-        }
-        templateSelect.click();
-        templateSelect.element.all(by.css('option')).get(2).click();
-        expect(includeElem.getText()).toMatch(/Content of template2.html/);
-      });
-
-      it('should change to blank', function() {
-        if (browser.params.browser == 'firefox') {
-          // Firefox can't handle using selects
-          return;
-        }
-        templateSelect.click();
-        templateSelect.element.all(by.css('option')).get(0).click();
-        expect(includeElem.isPresent()).toBe(false);
-      });
-    
-  
- */
-
-
-/**
- * @ngdoc event
- * @name ngInclude#$includeContentRequested
- * @eventType emit on the scope ngInclude was declared in
- * @description
- * Emitted every time the ngInclude content is requested.
- */
-
-
-/**
- * @ngdoc event
- * @name ngInclude#$includeContentLoaded
- * @eventType emit on the current ngInclude scope
- * @description
- * Emitted every time the ngInclude content is reloaded.
- */
-var ngIncludeDirective = ['$http', '$templateCache', '$anchorScroll', '$animate', '$sce',
-                  function($http,   $templateCache,   $anchorScroll,   $animate,   $sce) {
-  return {
-    restrict: 'ECA',
-    priority: 400,
-    terminal: true,
-    transclude: 'element',
-    controller: angular.noop,
-    compile: function(element, attr) {
-      var srcExp = attr.ngInclude || attr.src,
-          onloadExp = attr.onload || '',
-          autoScrollExp = attr.autoscroll;
-
-      return function(scope, $element, $attr, ctrl, $transclude) {
-        var changeCounter = 0,
-            currentScope,
-            previousElement,
-            currentElement;
-
-        var cleanupLastIncludeContent = function() {
-          if(previousElement) {
-            previousElement.remove();
-            previousElement = null;
-          }
-          if(currentScope) {
-            currentScope.$destroy();
-            currentScope = null;
-          }
-          if(currentElement) {
-            $animate.leave(currentElement, function() {
-              previousElement = null;
-            });
-            previousElement = currentElement;
-            currentElement = null;
-          }
-        };
-
-        scope.$watch($sce.parseAsResourceUrl(srcExp), function ngIncludeWatchAction(src) {
-          var afterAnimation = function() {
-            if (isDefined(autoScrollExp) && (!autoScrollExp || scope.$eval(autoScrollExp))) {
-              $anchorScroll();
-            }
-          };
-          var thisChangeId = ++changeCounter;
-
-          if (src) {
-            $http.get(src, {cache: $templateCache}).success(function(response) {
-              if (thisChangeId !== changeCounter) return;
-              var newScope = scope.$new();
-              ctrl.template = response;
-
-              // Note: This will also link all children of ng-include that were contained in the original
-              // html. If that content contains controllers, ... they could pollute/change the scope.
-              // However, using ng-include on an element with additional content does not make sense...
-              // Note: We can't remove them in the cloneAttchFn of $transclude as that
-              // function is called before linking the content, which would apply child
-              // directives to non existing elements.
-              var clone = $transclude(newScope, function(clone) {
-                cleanupLastIncludeContent();
-                $animate.enter(clone, null, $element, afterAnimation);
-              });
-
-              currentScope = newScope;
-              currentElement = clone;
-
-              currentScope.$emit('$includeContentLoaded');
-              scope.$eval(onloadExp);
-            }).error(function() {
-              if (thisChangeId === changeCounter) cleanupLastIncludeContent();
-            });
-            scope.$emit('$includeContentRequested');
-          } else {
-            cleanupLastIncludeContent();
-            ctrl.template = null;
-          }
-        });
-      };
-    }
-  };
-}];
-
-// This directive is called during the $transclude call of the first `ngInclude` directive.
-// It will replace and compile the content of the element with the loaded template.
-// We need this directive so that the element content is already filled when
-// the link function of another directive on the same element as ngInclude
-// is called.
-var ngIncludeFillContentDirective = ['$compile',
-  function($compile) {
-    return {
-      restrict: 'ECA',
-      priority: -400,
-      require: 'ngInclude',
-      link: function(scope, $element, $attr, ctrl) {
-        $element.html(ctrl.template);
-        $compile($element.contents())(scope);
-      }
-    };
-  }];
-
-/**
- * @ngdoc directive
- * @name ngInit
- * @restrict AC
- *
- * @description
- * The `ngInit` directive allows you to evaluate an expression in the
- * current scope.
- *
- * 

- * The only appropriate use of `ngInit` is for aliasing special properties of
- * {@link ng.directive:ngRepeat `ngRepeat`}, as seen in the demo below. Besides this case, you
- * should use {@link guide/controller controllers} rather than `ngInit`
- * to initialize values on a scope.
- * 

- * 

- * **Note**: If you have assignment in `ngInit` along with {@link ng.$filter `$filter`}, make
- * sure you have parenthesis for correct precedence:
- * 
- *   

- * 

- * 

- *
- * @priority 450
- *
- * @element ANY
- * @param {expression} ngInit {@link guide/expression Expression} to eval.
- *
- * @example
-   
-     
-   
-   

-     

-       

-          list[ {{outerIndex}} ][ {{innerIndex}} ] = {{value}};
-       

-     

-   

-     
-     
-       it('should alias index positions', function() {
-         var elements = element.all(by.css('.example-init'));
-         expect(elements.get(0).getText()).toBe('list[ 0 ][ 0 ] = a;');
-         expect(elements.get(1).getText()).toBe('list[ 0 ][ 1 ] = b;');
-         expect(elements.get(2).getText()).toBe('list[ 1 ][ 0 ] = c;');
-         expect(elements.get(3).getText()).toBe('list[ 1 ][ 1 ] = d;');
-       });
-     
-   
- */
-var ngInitDirective = ngDirective({
-  priority: 450,
-  compile: function() {
-    return {
-      pre: function(scope, element, attrs) {
-        scope.$eval(attrs.ngInit);
-      }
-    };
-  }
-});
-
-/**
- * @ngdoc directive
- * @name ngNonBindable
- * @restrict AC
- * @priority 1000
- *
- * @description
- * The `ngNonBindable` directive tells Angular not to compile or bind the contents of the current
- * DOM element. This is useful if the element contains what appears to be Angular directives and
- * bindings but which should be ignored by Angular. This could be the case if you have a site that
- * displays snippets of code, for instance.
- *
- * @element ANY
- *
- * @example
- * In this example there are two locations where a simple interpolation binding (`{{}}`) is present,
- * but the one wrapped in `ngNonBindable` is left alone.
- *
- * @example
-    
-      
-        
Normal: {{1 + 2}}

-        
Ignored: {{1 + 2}}

-      
-      
-       it('should check ng-non-bindable', function() {
-         expect(element(by.binding('1 + 2')).getText()).toContain('3');
-         expect(element.all(by.css('div')).last().getText()).toMatch(/1 \+ 2/);
-       });
-      
-    
- */
-var ngNonBindableDirective = ngDirective({ terminal: true, priority: 1000 });
-
-/**
- * @ngdoc directive
- * @name ngPluralize
- * @restrict EA
- *
- * @description
- * `ngPluralize` is a directive that displays messages according to en-US localization rules.
- * These rules are bundled with angular.js, but can be overridden
- * (see {@link guide/i18n Angular i18n} dev guide). You configure ngPluralize directive
- * by specifying the mappings between
- * [plural categories](http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html)
- * and the strings to be displayed.
- *
- * # Plural categories and explicit number rules
- * There are two
- * [plural categories](http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html)
- * in Angular's default en-US locale: "one" and "other".
- *
- * While a plural category may match many numbers (for example, in en-US locale, "other" can match
- * any number that is not 1), an explicit number rule can only match one number. For example, the
- * explicit number rule for "3" matches the number 3. There are examples of plural categories
- * and explicit number rules throughout the rest of this documentation.
- *
- * # Configuring ngPluralize
- * You configure ngPluralize by providing 2 attributes: `count` and `when`.
- * You can also provide an optional attribute, `offset`.
- *
- * The value of the `count` attribute can be either a string or an {@link guide/expression
- * Angular expression}; these are evaluated on the current scope for its bound value.
- *
- * The `when` attribute specifies the mappings between plural categories and the actual
- * string to be displayed. The value of the attribute should be a JSON object.
- *
- * The following example shows how to configure ngPluralize:
- *
- * ```html
- * 
- * 
- *```
- *
- * In the example, `"0: Nobody is viewing."` is an explicit number rule. If you did not
- * specify this rule, 0 would be matched to the "other" category and "0 people are viewing"
- * would be shown instead of "Nobody is viewing". You can specify an explicit number rule for
- * other numbers, for example 12, so that instead of showing "12 people are viewing", you can
- * show "a dozen people are viewing".
- *
- * You can use a set of closed braces (`{}`) as a placeholder for the number that you want substituted
- * into pluralized strings. In the previous example, Angular will replace `{}` with
- * `{{personCount}}`. The closed braces `{}` is a placeholder
- * for {{numberExpression}}.
- *
- * # Configuring ngPluralize with offset
- * The `offset` attribute allows further customization of pluralized text, which can result in
- * a better user experience. For example, instead of the message "4 people are viewing this document",
- * you might display "John, Kate and 2 others are viewing this document".
- * The offset attribute allows you to offset a number by any desired value.
- * Let's take a look at an example:
- *
- * ```html
- * 
- * 
- * ```
- *
- * Notice that we are still using two plural categories(one, other), but we added
- * three explicit number rules 0, 1 and 2.
- * When one person, perhaps John, views the document, "John is viewing" will be shown.
- * When three people view the document, no explicit number rule is found, so
- * an offset of 2 is taken off 3, and Angular uses 1 to decide the plural category.
- * In this case, plural category 'one' is matched and "John, Marry and one other person are viewing"
- * is shown.
- *
- * Note that when you specify offsets, you must provide explicit number rules for
- * numbers from 0 up to and including the offset. If you use an offset of 3, for example,
- * you must provide explicit number rules for 0, 1, 2 and 3. You must also provide plural strings for
- * plural categories "one" and "other".
- *
- * @param {string|expression} count The variable to be bound to.
- * @param {string} when The mapping between plural category to its corresponding strings.
- * @param {number=} offset Offset to deduct from the total number.
- *
- * @example
-    
-      
-        
-        

-          Person 1:

-          Person 2:

-          Number of People:

-
-          
-          Without Offset:
-          
-          

-
-          
-          With Offset(2):
-          
-          
-        

-      
-      
-        it('should show correct pluralized string', function() {
-          var withoutOffset = element.all(by.css('ng-pluralize')).get(0);
-          var withOffset = element.all(by.css('ng-pluralize')).get(1);
-          var countInput = element(by.model('personCount'));
-
-          expect(withoutOffset.getText()).toEqual('1 person is viewing.');
-          expect(withOffset.getText()).toEqual('Igor is viewing.');
-
-          countInput.clear();
-          countInput.sendKeys('0');
-
-          expect(withoutOffset.getText()).toEqual('Nobody is viewing.');
-          expect(withOffset.getText()).toEqual('Nobody is viewing.');
-
-          countInput.clear();
-          countInput.sendKeys('2');
-
-          expect(withoutOffset.getText()).toEqual('2 people are viewing.');
-          expect(withOffset.getText()).toEqual('Igor and Misko are viewing.');
-
-          countInput.clear();
-          countInput.sendKeys('3');
-
-          expect(withoutOffset.getText()).toEqual('3 people are viewing.');
-          expect(withOffset.getText()).toEqual('Igor, Misko and one other person are viewing.');
-
-          countInput.clear();
-          countInput.sendKeys('4');
-
-          expect(withoutOffset.getText()).toEqual('4 people are viewing.');
-          expect(withOffset.getText()).toEqual('Igor, Misko and 2 other people are viewing.');
-        });
-        it('should show data-bound names', function() {
-          var withOffset = element.all(by.css('ng-pluralize')).get(1);
-          var personCount = element(by.model('personCount'));
-          var person1 = element(by.model('person1'));
-          var person2 = element(by.model('person2'));
-          personCount.clear();
-          personCount.sendKeys('4');
-          person1.clear();
-          person1.sendKeys('Di');
-          person2.clear();
-          person2.sendKeys('Vojta');
-          expect(withOffset.getText()).toEqual('Di, Vojta and 2 other people are viewing.');
-        });
-      
-    
- */
-var ngPluralizeDirective = ['$locale', '$interpolate', function($locale, $interpolate) {
-  var BRACE = /{}/g;
-  return {
-    restrict: 'EA',
-    link: function(scope, element, attr) {
-      var numberExp = attr.count,
-          whenExp = attr.$attr.when && element.attr(attr.$attr.when), // we have {{}} in attrs
-          offset = attr.offset || 0,
-          whens = scope.$eval(whenExp) || {},
-          whensExpFns = {},
-          startSymbol = $interpolate.startSymbol(),
-          endSymbol = $interpolate.endSymbol(),
-          isWhen = /^when(Minus)?(.+)$/;
-
-      forEach(attr, function(expression, attributeName) {
-        if (isWhen.test(attributeName)) {
-          whens[lowercase(attributeName.replace('when', '').replace('Minus', '-'))] =
-            element.attr(attr.$attr[attributeName]);
-        }
-      });
-      forEach(whens, function(expression, key) {
-        whensExpFns[key] =
-          $interpolate(expression.replace(BRACE, startSymbol + numberExp + '-' +
-            offset + endSymbol));
-      });
-
-      scope.$watch(function ngPluralizeWatch() {
-        var value = parseFloat(scope.$eval(numberExp));
-
-        if (!isNaN(value)) {
-          //if explicit number rule such as 1, 2, 3... is defined, just use it. Otherwise,
-          //check it against pluralization rules in $locale service
-          if (!(value in whens)) value = $locale.pluralCat(value - offset);
-           return whensExpFns[value](scope, element, true);
-        } else {
-          return '';
-        }
-      }, function ngPluralizeWatchAction(newVal) {
-        element.text(newVal);
-      });
-    }
-  };
-}];
-
-/**
- * @ngdoc directive
- * @name ngRepeat
- *
- * @description
- * The `ngRepeat` directive instantiates a template once per item from a collection. Each template
- * instance gets its own scope, where the given loop variable is set to the current collection item,
- * and `$index` is set to the item index or key.
- *
- * Special properties are exposed on the local scope of each template instance, including:
- *
- * | Variable  | Type            | Details                                                                     |
- * |-----------|-----------------|-----------------------------------------------------------------------------|
- * | `$index`  | {@type number}  | iterator offset of the repeated element (0..length-1)                       |
- * | `$first`  | {@type boolean} | true if the repeated element is first in the iterator.                      |
- * | `$middle` | {@type boolean} | true if the repeated element is between the first and last in the iterator. |
- * | `$last`   | {@type boolean} | true if the repeated element is last in the iterator.                       |
- * | `$even`   | {@type boolean} | true if the iterator position `$index` is even (otherwise false).           |
- * | `$odd`    | {@type boolean} | true if the iterator position `$index` is odd (otherwise false).            |
- *
- * Creating aliases for these properties is possible with {@link ng.directive:ngInit `ngInit`}.
- * This may be useful when, for instance, nesting ngRepeats.
- *
- * # Special repeat start and end points
- * To repeat a series of elements instead of just one parent element, ngRepeat (as well as other ng directives) supports extending
- * the range of the repeater by defining explicit start and end points by using **ng-repeat-start** and **ng-repeat-end** respectively.
- * The **ng-repeat-start** directive works the same as **ng-repeat**, but will repeat all the HTML code (including the tag it's defined on)
- * up to and including the ending HTML tag where **ng-repeat-end** is placed.
- *
- * The example below makes use of this feature:
- * ```html
- *   

- *     Header {{ item }}
- *   

- *   

- *     Body {{ item }}
- *   

- *   

- *     Footer {{ item }}
- *   

- * ```
- *
- * And with an input of {@type ['A','B']} for the items variable in the example above, the output will evaluate to:
- * ```html
- *   

- *     Header A
- *   

- *   

- *     Body A
- *   

- *   

- *     Footer A
- *   

- *   

- *     Header B
- *   

- *   

- *     Body B
- *   

- *   

- *     Footer B
- *   

- * ```
- *
- * The custom start and end points for ngRepeat also support all other HTML directive syntax flavors provided in AngularJS (such
- * as **data-ng-repeat-start**, **x-ng-repeat-start** and **ng:repeat-start**).
- *
- * @animations
- * **.enter** - when a new item is added to the list or when an item is revealed after a filter
- *
- * **.leave** - when an item is removed from the list or when an item is filtered out
- *
- * **.move** - when an adjacent item is filtered out causing a reorder or when the item contents are reordered
- *
- * @element ANY
- * @scope
- * @priority 1000
- * @param {repeat_expression} ngRepeat The expression indicating how to enumerate a collection. These
- *   formats are currently supported:
- *
- *   * `variable in expression` – where variable is the user defined loop variable and `expression`
- *     is a scope expression giving the collection to enumerate.
- *
- *     For example: `album in artist.albums`.
- *
- *   * `(key, value) in expression` – where `key` and `value` can be any user defined identifiers,
- *     and `expression` is the scope expression giving the collection to enumerate.
- *
- *     For example: `(name, age) in {'adam':10, 'amalie':12}`.
- *
- *   * `variable in expression track by tracking_expression` – You can also provide an optional tracking function
- *     which can be used to associate the objects in the collection with the DOM elements. If no tracking function
- *     is specified the ng-repeat associates elements by identity in the collection. It is an error to have
- *     more than one tracking function to resolve to the same key. (This would mean that two distinct objects are
- *     mapped to the same DOM element, which is not possible.)  Filters should be applied to the expression,
- *     before specifying a tracking expression.
- *
- *     For example: `item in items` is equivalent to `item in items track by $id(item)'. This implies that the DOM elements
- *     will be associated by item identity in the array.
- *
- *     For example: `item in items track by $id(item)`. A built in `$id()` function can be used to assign a unique
- *     `$$hashKey` property to each item in the array. This property is then used as a key to associated DOM elements
- *     with the corresponding item in the array by identity. Moving the same object in array would move the DOM
- *     element in the same way in the DOM.
- *
- *     For example: `item in items track by item.id` is a typical pattern when the items come from the database. In this
- *     case the object identity does not matter. Two objects are considered equivalent as long as their `id`
- *     property is same.
- *
- *     For example: `item in items | filter:searchText track by item.id` is a pattern that might be used to apply a filter
- *     to items in conjunction with a tracking expression.
- *
- * @example
- * This example initializes the scope to a list of names and
- * then uses `ngRepeat` to display every person:
-  
-    
-      

-        I have {{friends.length}} friends. They are:
-        
-        
    
-          
  • 
-            [{{$index + 1}}] {{friend.name}} who is {{friend.age}} years old.
-          
    • 
-        

-      

-    
-    
-      .example-animate-container {
-        background:white;
-        border:1px solid black;
-        list-style:none;
-        margin:0;
-        padding:0 10px;
-      }
-
-      .animate-repeat {
-        line-height:40px;
-        list-style:none;
-        box-sizing:border-box;
-      }
-
-      .animate-repeat.ng-move,
-      .animate-repeat.ng-enter,
-      .animate-repeat.ng-leave {
-        -webkit-transition:all linear 0.5s;
-        transition:all linear 0.5s;
-      }
-
-      .animate-repeat.ng-leave.ng-leave-active,
-      .animate-repeat.ng-move,
-      .animate-repeat.ng-enter {
-        opacity:0;
-        max-height:0;
-      }
-
-      .animate-repeat.ng-leave,
-      .animate-repeat.ng-move.ng-move-active,
-      .animate-repeat.ng-enter.ng-enter-active {
-        opacity:1;
-        max-height:40px;
-      }
-    
-    
-      var friends = element.all(by.repeater('friend in friends'));
-
-      it('should render initial data set', function() {
-        expect(friends.count()).toBe(10);
-        expect(friends.get(0).getText()).toEqual('[1] John who is 25 years old.');
-        expect(friends.get(1).getText()).toEqual('[2] Jessie who is 30 years old.');
-        expect(friends.last().getText()).toEqual('[10] Samantha who is 60 years old.');
-        expect(element(by.binding('friends.length')).getText())
-            .toMatch("I have 10 friends. They are:");
-      });
-
-       it('should update repeater when filter predicate changes', function() {
-         expect(friends.count()).toBe(10);
-
-         element(by.model('q')).sendKeys('ma');
-
-         expect(friends.count()).toBe(2);
-         expect(friends.get(0).getText()).toEqual('[1] Mary who is 28 years old.');
-         expect(friends.last().getText()).toEqual('[2] Samantha who is 60 years old.');
-       });
-      
-    
- */
-var ngRepeatDirective = ['$parse', '$animate', function($parse, $animate) {
-  var NG_REMOVED = '$$NG_REMOVED';
-  var ngRepeatMinErr = minErr('ngRepeat');
-  return {
-    transclude: 'element',
-    priority: 1000,
-    terminal: true,
-    $$tlb: true,
-    link: function($scope, $element, $attr, ctrl, $transclude){
-        var expression = $attr.ngRepeat;
-        var match = expression.match(/^\s*([\s\S]+?)\s+in\s+([\s\S]+?)(?:\s+track\s+by\s+([\s\S]+?))?\s*$/),
-          trackByExp, trackByExpGetter, trackByIdExpFn, trackByIdArrayFn, trackByIdObjFn,
-          lhs, rhs, valueIdentifier, keyIdentifier,
-          hashFnLocals = {$id: hashKey};
-
-        if (!match) {
-          throw ngRepeatMinErr('iexp', "Expected expression in form of '_item_ in _collection_[ track by _id_]' but got '{0}'.",
-            expression);
-        }
-
-        lhs = match[1];
-        rhs = match[2];
-        trackByExp = match[3];
-
-        if (trackByExp) {
-          trackByExpGetter = $parse(trackByExp);
-          trackByIdExpFn = function(key, value, index) {
-            // assign key, value, and $index to the locals so that they can be used in hash functions
-            if (keyIdentifier) hashFnLocals[keyIdentifier] = key;
-            hashFnLocals[valueIdentifier] = value;
-            hashFnLocals.$index = index;
-            return trackByExpGetter($scope, hashFnLocals);
-          };
-        } else {
-          trackByIdArrayFn = function(key, value) {
-            return hashKey(value);
-          };
-          trackByIdObjFn = function(key) {
-            return key;
-          };
-        }
-
-        match = lhs.match(/^(?:([\$\w]+)|\(([\$\w]+)\s*,\s*([\$\w]+)\))$/);
-        if (!match) {
-          throw ngRepeatMinErr('iidexp', "'_item_' in '_item_ in _collection_' should be an identifier or '(_key_, _value_)' expression, but got '{0}'.",
-                                                                    lhs);
-        }
-        valueIdentifier = match[3] || match[1];
-        keyIdentifier = match[2];
-
-        // Store a list of elements from previous run. This is a hash where key is the item from the
-        // iterator, and the value is objects with following properties.
-        //   - scope: bound scope
-        //   - element: previous element.
-        //   - index: position
-        var lastBlockMap = {};
-
-        //watch props
-        $scope.$watchCollection(rhs, function ngRepeatAction(collection){
-          var index, length,
-              previousNode = $element[0],     // current position of the node
-              nextNode,
-              // Same as lastBlockMap but it has the current state. It will become the
-              // lastBlockMap on the next iteration.
-              nextBlockMap = {},
-              arrayLength,
-              childScope,
-              key, value, // key/value of iteration
-              trackById,
-              trackByIdFn,
-              collectionKeys,
-              block,       // last object information {scope, element, id}
-              nextBlockOrder = [],
-              elementsToRemove;
-
-
-          if (isArrayLike(collection)) {
-            collectionKeys = collection;
-            trackByIdFn = trackByIdExpFn || trackByIdArrayFn;
-          } else {
-            trackByIdFn = trackByIdExpFn || trackByIdObjFn;
-            // if object, extract keys, sort them and use to determine order of iteration over obj props
-            collectionKeys = [];
-            for (key in collection) {
-              if (collection.hasOwnProperty(key) && key.charAt(0) != '$') {
-                collectionKeys.push(key);
-              }
-            }
-            collectionKeys.sort();
-          }
-
-          arrayLength = collectionKeys.length;
-
-          // locate existing items
-          length = nextBlockOrder.length = collectionKeys.length;
-          for(index = 0; index < length; index++) {
-           key = (collection === collectionKeys) ? index : collectionKeys[index];
-           value = collection[key];
-           trackById = trackByIdFn(key, value, index);
-           assertNotHasOwnProperty(trackById, '`track by` id');
-           if(lastBlockMap.hasOwnProperty(trackById)) {
-             block = lastBlockMap[trackById];
-             delete lastBlockMap[trackById];
-             nextBlockMap[trackById] = block;
-             nextBlockOrder[index] = block;
-           } else if (nextBlockMap.hasOwnProperty(trackById)) {
-             // restore lastBlockMap
-             forEach(nextBlockOrder, function(block) {
-               if (block && block.scope) lastBlockMap[block.id] = block;
-             });
-             // This is a duplicate and we need to throw an error
-             throw ngRepeatMinErr('dupes', "Duplicates in a repeater are not allowed. Use 'track by' expression to specify unique keys. Repeater: {0}, Duplicate key: {1}",
-                                                                                                                                                    expression,       trackById);
-           } else {
-             // new never before seen block
-             nextBlockOrder[index] = { id: trackById };
-             nextBlockMap[trackById] = false;
-           }
-         }
-
-          // remove existing items
-          for (key in lastBlockMap) {
-            // lastBlockMap is our own object so we don't need to use special hasOwnPropertyFn
-            if (lastBlockMap.hasOwnProperty(key)) {
-              block = lastBlockMap[key];
-              elementsToRemove = getBlockElements(block.clone);
-              $animate.leave(elementsToRemove);
-              forEach(elementsToRemove, function(element) { element[NG_REMOVED] = true; });
-              block.scope.$destroy();
-            }
-          }
-
-          // we are not using forEach for perf reasons (trying to avoid #call)
-          for (index = 0, length = collectionKeys.length; index < length; index++) {
-            key = (collection === collectionKeys) ? index : collectionKeys[index];
-            value = collection[key];
-            block = nextBlockOrder[index];
-            if (nextBlockOrder[index - 1]) previousNode = getBlockEnd(nextBlockOrder[index - 1]);
-
-            if (block.scope) {
-              // if we have already seen this object, then we need to reuse the
-              // associated scope/element
-              childScope = block.scope;
-
-              nextNode = previousNode;
-              do {
-                nextNode = nextNode.nextSibling;
-              } while(nextNode && nextNode[NG_REMOVED]);
-
-              if (getBlockStart(block) != nextNode) {
-                // existing item which got moved
-                $animate.move(getBlockElements(block.clone), null, jqLite(previousNode));
-              }
-              previousNode = getBlockEnd(block);
-            } else {
-              // new item which we don't know about
-              childScope = $scope.$new();
-            }
-
-            childScope[valueIdentifier] = value;
-            if (keyIdentifier) childScope[keyIdentifier] = key;
-            childScope.$index = index;
-            childScope.$first = (index === 0);
-            childScope.$last = (index === (arrayLength - 1));
-            childScope.$middle = !(childScope.$first || childScope.$last);
-            // jshint bitwise: false
-            childScope.$odd = !(childScope.$even = (index&1) === 0);
-            // jshint bitwise: true
-
-            if (!block.scope) {
-              $transclude(childScope, function(clone) {
-                clone[clone.length++] = document.createComment(' end ngRepeat: ' + expression + ' ');
-                $animate.enter(clone, null, jqLite(previousNode));
-                previousNode = clone;
-                block.scope = childScope;
-                // Note: We only need the first/last node of the cloned nodes.
-                // However, we need to keep the reference to the jqlite wrapper as it might be changed later
-                // by a directive with templateUrl when it's template arrives.
-                block.clone = clone;
-                nextBlockMap[block.id] = block;
-              });
-            }
-          }
-          lastBlockMap = nextBlockMap;
-        });
-    }
-  };
-
-  function getBlockStart(block) {
-    return block.clone[0];
-  }
-
-  function getBlockEnd(block) {
-    return block.clone[block.clone.length - 1];
-  }
-}];
-
-/**
- * @ngdoc directive
- * @name ngShow
- *
- * @description
- * The `ngShow` directive shows or hides the given HTML element based on the expression
- * provided to the ngShow attribute. The element is shown or hidden by removing or adding
- * the `ng-hide` CSS class onto the element. The `.ng-hide` CSS class is predefined
- * in AngularJS and sets the display style to none (using an !important flag).
- * For CSP mode please add `angular-csp.css` to your html file (see {@link ng.directive:ngCsp ngCsp}).
- *
- * ```html
- * 
- * 

- *
- * 
- * 

- * ```
- *
- * When the ngShow expression evaluates to false then the ng-hide CSS class is added to the class attribute
- * on the element causing it to become hidden. When true, the ng-hide CSS class is removed
- * from the element causing the element not to appear hidden.
- *
- * ## Why is !important used?
- *
- * You may be wondering why !important is used for the .ng-hide CSS class. This is because the `.ng-hide` selector
- * can be easily overridden by heavier selectors. For example, something as simple
- * as changing the display style on a HTML list item would make hidden elements appear visible.
- * This also becomes a bigger issue when dealing with CSS frameworks.
- *
- * By using !important, the show and hide behavior will work as expected despite any clash between CSS selector
- * specificity (when !important isn't used with any conflicting styles). If a developer chooses to override the
- * styling to change how to hide an element then it is just a matter of using !important in their own CSS code.
- *
- * ### Overriding .ng-hide
- *
- * If you wish to change the hide behavior with ngShow/ngHide then this can be achieved by
- * restating the styles for the .ng-hide class in CSS:
- * ```css
- * .ng-hide {
- *   //!annotate CSS Specificity|Not to worry, this will override the AngularJS default...
- *   display:block!important;
- *
- *   //this is just another form of hiding an element
- *   position:absolute;
- *   top:-9999px;
- *   left:-9999px;
- * }
- * ```
- *
- * Just remember to include the important flag so the CSS override will function.
- *
- * 

- * **Note:** Here is a list of values that ngShow will consider as a falsy value (case insensitive):

- * "f" / "0" / "false" / "no" / "n" / "[]"
- * 

- *
- * ## A note about animations with ngShow
- *
- * Animations in ngShow/ngHide work with the show and hide events that are triggered when the directive expression
- * is true and false. This system works like the animation system present with ngClass except that
- * you must also include the !important flag to override the display property
- * so that you can perform an animation when the element is hidden during the time of the animation.
- *
- * ```css
- * //
- * //a working example can be found at the bottom of this page
- * //
- * .my-element.ng-hide-add, .my-element.ng-hide-remove {
- *   transition:0.5s linear all;
- *   display:block!important;
- * }
- *
- * .my-element.ng-hide-add { ... }
- * .my-element.ng-hide-add.ng-hide-add-active { ... }
- * .my-element.ng-hide-remove { ... }
- * .my-element.ng-hide-remove.ng-hide-remove-active { ... }
- * ```
- *
- * @animations
- * addClass: .ng-hide - happens after the ngShow expression evaluates to a truthy value and the just before contents are set to visible
- * removeClass: .ng-hide - happens after the ngShow expression evaluates to a non truthy value and just before the contents are set to hidden
- *
- * @element ANY
- * @param {expression} ngShow If the {@link guide/expression expression} is truthy
- *     then the element is shown or hidden respectively.
- *
- * @example
-  
-    
-      Click me: 

-      

-        Show:
-        

-           I show up when your checkbox is checked.
-        

-      

-      

-        Hide:
-        

-           I hide when your checkbox is checked.
-        

-      

-    
-    
-      @import url(//netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap-glyphicons.css);
-    
-    
-      .animate-show {
-        -webkit-transition:all linear 0.5s;
-        transition:all linear 0.5s;
-        line-height:20px;
-        opacity:1;
-        padding:10px;
-        border:1px solid black;
-        background:white;
-      }
-
-      .animate-show.ng-hide-add,
-      .animate-show.ng-hide-remove {
-        display:block!important;
-      }
-
-      .animate-show.ng-hide {
-        line-height:0;
-        opacity:0;
-        padding:0 10px;
-      }
-
-      .check-element {
-        padding:10px;
-        border:1px solid black;
-        background:white;
-      }
-    
-    
-      var thumbsUp = element(by.css('span.glyphicon-thumbs-up'));
-      var thumbsDown = element(by.css('span.glyphicon-thumbs-down'));
-
-      it('should check ng-show / ng-hide', function() {
-        expect(thumbsUp.isDisplayed()).toBeFalsy();
-        expect(thumbsDown.isDisplayed()).toBeTruthy();
-
-        element(by.model('checked')).click();
-
-        expect(thumbsUp.isDisplayed()).toBeTruthy();
-        expect(thumbsDown.isDisplayed()).toBeFalsy();
-      });
-    
-  
- */
-var ngShowDirective = ['$animate', function($animate) {
-  return function(scope, element, attr) {
-    scope.$watch(attr.ngShow, function ngShowWatchAction(value){
-      $animate[toBoolean(value) ? 'removeClass' : 'addClass'](element, 'ng-hide');
-    });
-  };
-}];
-
-
-/**
- * @ngdoc directive
- * @name ngHide
- *
- * @description
- * The `ngHide` directive shows or hides the given HTML element based on the expression
- * provided to the ngHide attribute. The element is shown or hidden by removing or adding
- * the `ng-hide` CSS class onto the element. The `.ng-hide` CSS class is predefined
- * in AngularJS and sets the display style to none (using an !important flag).
- * For CSP mode please add `angular-csp.css` to your html file (see {@link ng.directive:ngCsp ngCsp}).
- *
- * ```html
- * 
- * 

- *
- * 
- * 

- * ```
- *
- * When the ngHide expression evaluates to true then the .ng-hide CSS class is added to the class attribute
- * on the element causing it to become hidden. When false, the ng-hide CSS class is removed
- * from the element causing the element not to appear hidden.
- *
- * ## Why is !important used?
- *
- * You may be wondering why !important is used for the .ng-hide CSS class. This is because the `.ng-hide` selector
- * can be easily overridden by heavier selectors. For example, something as simple
- * as changing the display style on a HTML list item would make hidden elements appear visible.
- * This also becomes a bigger issue when dealing with CSS frameworks.
- *
- * By using !important, the show and hide behavior will work as expected despite any clash between CSS selector
- * specificity (when !important isn't used with any conflicting styles). If a developer chooses to override the
- * styling to change how to hide an element then it is just a matter of using !important in their own CSS code.
- *
- * ### Overriding .ng-hide
- *
- * If you wish to change the hide behavior with ngShow/ngHide then this can be achieved by
- * restating the styles for the .ng-hide class in CSS:
- * ```css
- * .ng-hide {
- *   //!annotate CSS Specificity|Not to worry, this will override the AngularJS default...
- *   display:block!important;
- *
- *   //this is just another form of hiding an element
- *   position:absolute;
- *   top:-9999px;
- *   left:-9999px;
- * }
- * ```
- *
- * Just remember to include the important flag so the CSS override will function.
- *
- * 

- * **Note:** Here is a list of values that ngHide will consider as a falsy value (case insensitive):

- * "f" / "0" / "false" / "no" / "n" / "[]"
- * 

- *
- * ## A note about animations with ngHide
- *
- * Animations in ngShow/ngHide work with the show and hide events that are triggered when the directive expression
- * is true and false. This system works like the animation system present with ngClass, except that
- * you must also include the !important flag to override the display property so
- * that you can perform an animation when the element is hidden during the time of the animation.
- *
- * ```css
- * //
- * //a working example can be found at the bottom of this page
- * //
- * .my-element.ng-hide-add, .my-element.ng-hide-remove {
- *   transition:0.5s linear all;
- *   display:block!important;
- * }
- *
- * .my-element.ng-hide-add { ... }
- * .my-element.ng-hide-add.ng-hide-add-active { ... }
- * .my-element.ng-hide-remove { ... }
- * .my-element.ng-hide-remove.ng-hide-remove-active { ... }
- * ```
- *
- * @animations
- * removeClass: .ng-hide - happens after the ngHide expression evaluates to a truthy value and just before the contents are set to hidden
- * addClass: .ng-hide - happens after the ngHide expression evaluates to a non truthy value and just before the contents are set to visible
- *
- * @element ANY
- * @param {expression} ngHide If the {@link guide/expression expression} is truthy then
- *     the element is shown or hidden respectively.
- *
- * @example
-  
-    
-      Click me: 

-      

-        Show:
-        

-           I show up when your checkbox is checked.
-        

-      

-      

-        Hide:
-        

-           I hide when your checkbox is checked.
-        

-      

-    
-    
-      @import url(//netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap-glyphicons.css);
-    
-    
-      .animate-hide {
-        -webkit-transition:all linear 0.5s;
-        transition:all linear 0.5s;
-        line-height:20px;
-        opacity:1;
-        padding:10px;
-        border:1px solid black;
-        background:white;
-      }
-
-      .animate-hide.ng-hide-add,
-      .animate-hide.ng-hide-remove {
-        display:block!important;
-      }
-
-      .animate-hide.ng-hide {
-        line-height:0;
-        opacity:0;
-        padding:0 10px;
-      }
-
-      .check-element {
-        padding:10px;
-        border:1px solid black;
-        background:white;
-      }
-    
-    
-      var thumbsUp = element(by.css('span.glyphicon-thumbs-up'));
-      var thumbsDown = element(by.css('span.glyphicon-thumbs-down'));
-
-      it('should check ng-show / ng-hide', function() {
-        expect(thumbsUp.isDisplayed()).toBeFalsy();
-        expect(thumbsDown.isDisplayed()).toBeTruthy();
-
-        element(by.model('checked')).click();
-
-        expect(thumbsUp.isDisplayed()).toBeTruthy();
-        expect(thumbsDown.isDisplayed()).toBeFalsy();
-      });
-    
-  
- */
-var ngHideDirective = ['$animate', function($animate) {
-  return function(scope, element, attr) {
-    scope.$watch(attr.ngHide, function ngHideWatchAction(value){
-      $animate[toBoolean(value) ? 'addClass' : 'removeClass'](element, 'ng-hide');
-    });
-  };
-}];
-
-/**
- * @ngdoc directive
- * @name ngStyle
- * @restrict AC
- *
- * @description
- * The `ngStyle` directive allows you to set CSS style on an HTML element conditionally.
- *
- * @element ANY
- * @param {expression} ngStyle {@link guide/expression Expression} which evals to an
- *      object whose keys are CSS style names and values are corresponding values for those CSS
- *      keys.
- *
- * @example
-   
-     
-        
-        
-        

-        Sample Text
-        
myStyle={{myStyle}}

-     
-     
-       span {
-         color: black;
-       }
-     
-     
-       var colorSpan = element(by.css('span'));
-
-       it('should check ng-style', function() {
-         expect(colorSpan.getCssValue('color')).toBe('rgba(0, 0, 0, 1)');
-         element(by.css('input[value=set]')).click();
-         expect(colorSpan.getCssValue('color')).toBe('rgba(255, 0, 0, 1)');
-         element(by.css('input[value=clear]')).click();
-         expect(colorSpan.getCssValue('color')).toBe('rgba(0, 0, 0, 1)');
-       });
-     
-   
- */
-var ngStyleDirective = ngDirective(function(scope, element, attr) {
-  scope.$watch(attr.ngStyle, function ngStyleWatchAction(newStyles, oldStyles) {
-    if (oldStyles && (newStyles !== oldStyles)) {
-      forEach(oldStyles, function(val, style) { element.css(style, '');});
-    }
-    if (newStyles) element.css(newStyles);
-  }, true);
-});
-
-/**
- * @ngdoc directive
- * @name ngSwitch
- * @restrict EA
- *
- * @description
- * The `ngSwitch` directive is used to conditionally swap DOM structure on your template based on a scope expression.
- * Elements within `ngSwitch` but without `ngSwitchWhen` or `ngSwitchDefault` directives will be preserved at the location
- * as specified in the template.
- *
- * The directive itself works similar to ngInclude, however, instead of downloading template code (or loading it
- * from the template cache), `ngSwitch` simply chooses one of the nested elements and makes it visible based on which element
- * matches the value obtained from the evaluated expression. In other words, you define a container element
- * (where you place the directive), place an expression on the **`on="..."` attribute**
- * (or the **`ng-switch="..."` attribute**), define any inner elements inside of the directive and place
- * a when attribute per element. The when attribute is used to inform ngSwitch which element to display when the on
- * expression is evaluated. If a matching expression is not found via a when attribute then an element with the default
- * attribute is displayed.
- *
- * 

- * Be aware that the attribute values to match against cannot be expressions. They are interpreted
- * as literal string values to match against.
- * For example, **`ng-switch-when="someVal"`** will match against the string `"someVal"` not against the
- * value of the expression `$scope.someVal`.
- * 

-
- * @animations
- * enter - happens after the ngSwitch contents change and the matched child element is placed inside the container
- * leave - happens just after the ngSwitch contents change and just before the former contents are removed from the DOM
- *
- * @usage
- * 
- *   ...
- *   ...
- *   ...
- * 
- *
- *
- * @scope
- * @priority 800
- * @param {*} ngSwitch|on expression to match against ng-switch-when.
- * On child elements add:
- *
- * * `ngSwitchWhen`: the case statement to match against. If match then this
- *   case will be displayed. If the same match appears multiple times, all the
- *   elements will be displayed.
- * * `ngSwitchDefault`: the default case when no other case match. If there
- *   are multiple default cases, all of them will be displayed when no other
- *   case match.
- *
- *
- * @example
-  
-    
-      

-        
-        selection={{selection}}
-        

-        

-            
Settings Div

-            
Home Span

-            
default

-        

-      

-    
-    
-      function Ctrl($scope) {
-        $scope.items = ['settings', 'home', 'other'];
-        $scope.selection = $scope.items[0];
-      }
-    
-    
-      .animate-switch-container {
-        position:relative;
-        background:white;
-        border:1px solid black;
-        height:40px;
-        overflow:hidden;
-      }
-
-      .animate-switch {
-        padding:10px;
-      }
-
-      .animate-switch.ng-animate {
-        -webkit-transition:all cubic-bezier(0.250, 0.460, 0.450, 0.940) 0.5s;
-        transition:all cubic-bezier(0.250, 0.460, 0.450, 0.940) 0.5s;
-
-        position:absolute;
-        top:0;
-        left:0;
-        right:0;
-        bottom:0;
-      }
-
-      .animate-switch.ng-leave.ng-leave-active,
-      .animate-switch.ng-enter {
-        top:-50px;
-      }
-      .animate-switch.ng-leave,
-      .animate-switch.ng-enter.ng-enter-active {
-        top:0;
-      }
-    
-    
-      var switchElem = element(by.css('[ng-switch]'));
-      var select = element(by.model('selection'));
-
-      it('should start in settings', function() {
-        expect(switchElem.getText()).toMatch(/Settings Div/);
-      });
-      it('should change to home', function() {
-        select.element.all(by.css('option')).get(1).click();
-        expect(switchElem.getText()).toMatch(/Home Span/);
-      });
-      it('should select default', function() {
-        select.element.all(by.css('option')).get(2).click();
-        expect(switchElem.getText()).toMatch(/default/);
-      });
-    
-  
- */
-var ngSwitchDirective = ['$animate', function($animate) {
-  return {
-    restrict: 'EA',
-    require: 'ngSwitch',
-
-    // asks for $scope to fool the BC controller module
-    controller: ['$scope', function ngSwitchController() {
-     this.cases = {};
-    }],
-    link: function(scope, element, attr, ngSwitchController) {
-      var watchExpr = attr.ngSwitch || attr.on,
-          selectedTranscludes,
-          selectedElements,
-          previousElements,
-          selectedScopes = [];
-
-      scope.$watch(watchExpr, function ngSwitchWatchAction(value) {
-        var i, ii = selectedScopes.length;
-        if(ii > 0) {
-          if(previousElements) {
-            for (i = 0; i < ii; i++) {
-              previousElements[i].remove();
-            }
-            previousElements = null;
-          }
-
-          previousElements = [];
-          for (i= 0; i
-     
-       
-       

-         

-          

-         {{text}}
-       

-     
-     
-        it('should have transcluded', function() {
-          var titleElement = element(by.model('title'));
-          titleElement.clear();
-          titleElement.sendKeys('TITLE');
-          var textElement = element(by.model('text'));
-          textElement.clear();
-          textElement.sendKeys('TEXT');
-          expect(element(by.binding('title')).getText()).toEqual('TITLE');
-          expect(element(by.binding('text')).getText()).toEqual('TEXT');
-        });
-     
-   
- *
- */
-var ngTranscludeDirective = ngDirective({
-  link: function($scope, $element, $attrs, controller, $transclude) {
-    if (!$transclude) {
-      throw minErr('ngTransclude')('orphan',
-       'Illegal use of ngTransclude directive in the template! ' +
-       'No parent directive that requires a transclusion found. ' +
-       'Element: {0}',
-       startingTag($element));
-    }
-
-    $transclude(function(clone) {
-      $element.empty();
-      $element.append(clone);
-    });
-  }
-});
-
-/**
- * @ngdoc directive
- * @name script
- * @restrict E
- *
- * @description
- * Load the content of a `
-
-      Load inlined template
-      

-    
-    
-      it('should load template defined inside script tag', function() {
-        element(by.css('#tpl-link')).click();
-        expect(element(by.css('#tpl-content')).getText()).toMatch(/Content of the template/);
-      });
-    
-  
- */
-var scriptDirective = ['$templateCache', function($templateCache) {
-  return {
-    restrict: 'E',
-    terminal: true,
-    compile: function(element, attr) {
-      if (attr.type == 'text/ng-template') {
-        var templateUrl = attr.id,
-            // IE is not consistent, in scripts we have to read .text but in other nodes we have to read .textContent
-            text = element[0].text;
-
-        $templateCache.put(templateUrl, text);
-      }
-    }
-  };
-}];
-
-var ngOptionsMinErr = minErr('ngOptions');
-/**
- * @ngdoc directive
- * @name select
- * @restrict E
- *
- * @description
- * HTML `SELECT` element with angular data-binding.
- *
- * # `ngOptions`
- *
- * The `ngOptions` attribute can be used to dynamically generate a list of ``
- *      DOM element.
- *   * `trackexpr`: Used when working with an array of objects. The result of this expression will be
- *      used to identify the objects in the array. The `trackexpr` will most likely refer to the
- *     `value` variable (e.g. `value.propertyName`).
- *
- * @example
-    
-      
-        
-        

-          
    
-            
  • 
-              Name: 
-              [X]
-            
    • 
-            
  • 
-              [add]
-            
    • 
-          

-          

-          Color (null not allowed):
-          

-
-          Color (null allowed):
-          
-            
-          

-
-          Color grouped by shade:
-          

-
-
-          Select bogus.

-          

-          Currently selected: {{ {selected_color:color}  }}
-          

-          

-        

-      
-      
-         it('should check ng-options', function() {
-           expect(element(by.binding('{selected_color:color}')).getText()).toMatch('red');
-           element.all(by.select('color')).first().click();
-           element.all(by.css('select[ng-model="color"] option')).first().click();
-           expect(element(by.binding('{selected_color:color}')).getText()).toMatch('black');
-           element(by.css('.nullable select[ng-model="color"]')).click();
-           element.all(by.css('.nullable select[ng-model="color"] option')).first().click();
-           expect(element(by.binding('{selected_color:color}')).getText()).toMatch('null');
-         });
-      
-    
- */
-
-var ngOptionsDirective = valueFn({ terminal: true });
-// jshint maxlen: false
-var selectDirective = ['$compile', '$parse', function($compile,   $parse) {
-                         //000011111111110000000000022222222220000000000000000000003333333333000000000000004444444444444440000000005555555555555550000000666666666666666000000000000000777777777700000000000000000008888888888
-  var NG_OPTIONS_REGEXP = /^\s*([\s\S]+?)(?:\s+as\s+([\s\S]+?))?(?:\s+group\s+by\s+([\s\S]+?))?\s+for\s+(?:([\$\w][\$\w]*)|(?:\(\s*([\$\w][\$\w]*)\s*,\s*([\$\w][\$\w]*)\s*\)))\s+in\s+([\s\S]+?)(?:\s+track\s+by\s+([\s\S]+?))?$/,
-      nullModelCtrl = {$setViewValue: noop};
-// jshint maxlen: 100
-
-  return {
-    restrict: 'E',
-    require: ['select', '?ngModel'],
-    controller: ['$element', '$scope', '$attrs', function($element, $scope, $attrs) {
-      var self = this,
-          optionsMap = {},
-          ngModelCtrl = nullModelCtrl,
-          nullOption,
-          unknownOption;
-
-
-      self.databound = $attrs.ngModel;
-
-
-      self.init = function(ngModelCtrl_, nullOption_, unknownOption_) {
-        ngModelCtrl = ngModelCtrl_;
-        nullOption = nullOption_;
-        unknownOption = unknownOption_;
-      };
-
-
-      self.addOption = function(value) {
-        assertNotHasOwnProperty(value, '"option value"');
-        optionsMap[value] = true;
-
-        if (ngModelCtrl.$viewValue == value) {
-          $element.val(value);
-          if (unknownOption.parent()) unknownOption.remove();
-        }
-      };
-
-
-      self.removeOption = function(value) {
-        if (this.hasOption(value)) {
-          delete optionsMap[value];
-          if (ngModelCtrl.$viewValue == value) {
-            this.renderUnknownOption(value);
-          }
-        }
-      };
-
-
-      self.renderUnknownOption = function(val) {
-        var unknownVal = '? ' + hashKey(val) + ' ?';
-        unknownOption.val(unknownVal);
-        $element.prepend(unknownOption);
-        $element.val(unknownVal);
-        unknownOption.prop('selected', true); // needed for IE
-      };
-
-
-      self.hasOption = function(value) {
-        return optionsMap.hasOwnProperty(value);
-      };
-
-      $scope.$on('$destroy', function() {
-        // disable unknown option so that we don't do work when the whole select is being destroyed
-        self.renderUnknownOption = noop;
-      });
-    }],
-
-    link: function(scope, element, attr, ctrls) {
-      // if ngModel is not defined, we don't need to do anything
-      if (!ctrls[1]) return;
-
-      var selectCtrl = ctrls[0],
-          ngModelCtrl = ctrls[1],
-          multiple = attr.multiple,
-          optionsExp = attr.ngOptions,
-          nullOption = false, // if false, user will not be able to select it (used by ngOptions)
-          emptyOption,
-          // we can't just jqLite('