From ed45c77be51b624968d0ae58415cc7bb23656a75 Mon Sep 17 00:00:00 2001 From: "Gerasimos (Makis) Maropoulos" Date: Sun, 7 Jun 2020 15:26:06 +0300 Subject: [PATCH] reorganization of _examples and add some new examples such as iris+groupcache+mysql+docker Former-commit-id: ed635ee95de7160cde11eaabc0c1dcb0e460a620 --- HISTORY.md | 19 +- HISTORY_ES.md | 2 +- _examples/README.md | 192 +- _examples/apidoc/swagger/README.md | 3 + .../basicauth/main.go | 0 .../basicauth/main_test.go | 0 .../oauth2 => auth/goth}/main.go | 0 .../oauth2 => auth/goth}/templates/index.html | 4 +- .../oauth2 => auth/goth}/templates/user.html | 20 +- .../{miscellaneous => auth}/hcaptcha/hosts | 0 .../{miscellaneous => auth}/hcaptcha/main.go | 0 .../hcaptcha/templates/register_form.html | 0 .../{miscellaneous => auth}/jwt/README.md | 0 _examples/{miscellaneous => auth}/jwt/main.go | 6 +- .../jwt/rsa_password_protected.key | 0 _examples/{ => auth}/permissions/main.go | 0 .../recaptcha/custom_form/main.go | 0 .../{miscellaneous => auth}/recaptcha/main.go | 0 _examples/authentication/README.md | 7 - .../bootstrap/bootstrap/bootstrapper.go | 0 .../bootstrap/folder_structure.png | Bin _examples/{structuring => }/bootstrap/main.go | 6 +- .../{structuring => }/bootstrap/main_test.go | 6 +- .../bootstrap/middleware/identity/identity.go | 2 +- .../bootstrap/public/favicon.ico | Bin .../bootstrap/routes/follower.go | 0 .../bootstrap/routes/following.go | 0 .../bootstrap/routes/index.go | 0 .../bootstrap/routes/like.go | 0 _examples/bootstrap/routes/routes.go | 13 + .../bootstrap/views/index.html | 0 .../bootstrap/views/shared/error.html | 8 +- .../bootstrap/views/shared/layout.html | 44 +- _examples/{tutorial => }/caddy/Caddyfile | 16 +- _examples/{tutorial => }/caddy/README.md | 46 +- .../{tutorial => }/caddy/server1/main.go | 0 .../caddy/server1/views/index.html | 4 +- .../caddy/server1/views/shared/layout.html | 20 +- .../{tutorial => }/caddy/server2/main.go | 2 +- _examples/{tutorial => database}/mongodb/.env | 0 .../mongodb/0_create_movie.png | Bin .../mongodb/1_update_movie.png | Bin .../mongodb/2_get_all_movies.png | Bin .../mongodb/3_get_movie.png | Bin .../mongodb/4_delete_movie.png | Bin _examples/database/mongodb/Dockerfile | 17 + .../{tutorial => database}/mongodb/README.md | 12 +- .../mongodb/api/store/movie.go | 4 +- _examples/database/mongodb/docker-compose.yml | 18 + .../{tutorial => database}/mongodb/env/env.go | 40 +- _examples/database/mongodb/go.mod | 9 + .../mongodb/httputil/error.go | 0 .../{tutorial => database}/mongodb/main.go | 8 +- .../mongodb/store/movie.go | 0 _examples/database/mysql/Dockerfile | 17 + _examples/database/mysql/README.md | 146 + _examples/database/mysql/api/api.go | 97 + .../database/mysql/api/category_handler.go | 251 + _examples/database/mysql/api/helper.go | 25 + _examples/database/mysql/api/httperror.go | 60 + .../mysql/api/middleware}/.gitkeep | 0 .../database/mysql/api/product_handler.go | 173 + _examples/database/mysql/cache/groupcache.go | 120 + _examples/database/mysql/docker-compose.yml | 32 + _examples/database/mysql/entity/category.go | 89 + _examples/database/mysql/entity/product.go | 95 + _examples/database/mysql/go.mod | 9 + _examples/database/mysql/main.go | 44 + .../api_category/create_category.json | 5 + .../insert_products_category.json | 31 + .../api_category/update_category.json | 6 + .../api_category/update_partial_category.json | 3 + .../database/mysql/migration/api_postman.json | 484 + .../migration/api_product/create_product.json | 7 + .../api_product/update_partial_product.json | 3 + .../migration/api_product/update_product.json | 8 + _examples/database/mysql/migration/db.sql | 33 + .../mysql/service/category_service.go | 74 + .../mysql/service/category_service_test.go | 42 + .../database/mysql/service/product_service.go | 110 + _examples/database/mysql/sql/mysql.go | 123 + _examples/database/mysql/sql/service.go | 243 + _examples/database/mysql/sql/sql.go | 40 + _examples/{ => database}/orm/gorm/REAMDE.md | 0 _examples/{ => database}/orm/gorm/main.go | 0 _examples/{ => database}/orm/xorm/main.go | 0 .../dependency-injection/jwt/contrib/main.go | 66 + _examples/dependency-injection/jwt/main.go | 70 +- .../{desktop-app => desktop}/blink/main.go | 0 .../{desktop-app => desktop}/lorca/main.go | 0 .../{desktop-app => desktop}/webview/main.go | 0 _examples/{tutorial => }/dropzonejs/README.md | 334 +- .../{tutorial => }/dropzonejs/README_PART2.md | 618 +- .../dropzonejs/folder_structure.png | Bin _examples/{tutorial => }/dropzonejs/meta.yml | 0 .../{tutorial => }/dropzonejs/no_files.png | Bin .../{tutorial => }/dropzonejs/src/main.go | 0 .../dropzonejs/src/public/css/dropzone.css | 0 .../dropzonejs/src/public/js/dropzone.js | 0 .../dropzonejs/src/views/upload.html | 104 +- .../{tutorial => }/dropzonejs/with_files.png | Bin _examples/experimental-handlers/README.md | 5 - .../casbin/middleware/casbinmodel.conf | 14 - .../casbin/middleware/casbinpolicy.csv | 5 - .../casbin/middleware/main.go | 43 - .../casbin/middleware/main_test.go | 48 - .../casbin/wrapper/casbinmodel.conf | 14 - .../casbin/wrapper/casbinpolicy.csv | 7 - .../casbin/wrapper/main.go | 43 - .../casbin/wrapper/main_test.go | 78 - .../cloudwatch/simple/main.go | 50 - .../cors/simple/client/index.html | 41 - .../cors/simple/client/main.go | 14 - .../experimental-handlers/cors/simple/main.go | 55 - _examples/experimental-handlers/csrf/main.go | 55 - .../csrf/views/user/signup.html | 4 - _examples/experimental-handlers/jwt/main.go | 56 - .../newrelic/simple/main.go | 24 - .../prometheus/simple/main.go | 39 - .../secure/simple/main.go | 38 - .../tollboothic/limit-handler/main.go | 31 - .../basic/assets/js/jquery-2.1.1.js | 9191 +---------------- .../assets/js/jquery-2.1.1.js | 9191 +---------------- .../embedding-files-into-app/bindata.go | 12 +- .../assets/js/jquery-2.1.1.js | 9191 +---------------- .../bindata_gzip.go | 2702 +---- .../subdomain/assets/js/jquery-2.1.1.js | 9191 +---------------- .../upload-file/main.go | 0 .../upload-file/templates/upload_form.html | 0 .../upload-file}/uploads/.gitkeep | 0 .../upload-files/main.go | 0 .../upload-files/main_test.go | 0 .../upload-files/templates/upload_form.html | 24 +- .../upload-files/uploads}/.gitkeep | 0 .../{http-listening => http-server}/README.md | 0 .../custom-httpserver/easy-way/main.go | 0 .../custom-httpserver/multi/main.go | 0 .../custom-httpserver/std-way/main.go | 0 .../custom-listener/main.go | 0 .../custom-listener/unix-reuseport/main.go | 0 .../unix-reuseport/main_windows.go | 0 .../graceful-shutdown/custom-notifier/main.go | 0 .../default-notifier/main.go | 0 .../http3-quic/go.mod | 2 +- .../http3-quic/localhost.cert | 0 .../http3-quic/localhost.key | 0 .../http3-quic/main.go | 0 .../main.go | 0 .../listen-addr-public/main.go | 0 .../listen-addr/main.go | 0 .../listen-addr/omit-server-errors/main.go | 0 .../omit-server-errors/main_test.go | 0 .../listen-letsencrypt/main.go | 0 .../listen-tls/main.go | 0 .../listen-tls/mycert.cert | 38 +- .../listen-tls/mykey.key | 54 +- .../listen-unix/main.go | 0 .../notify-on-shutdown/main.go | 0 _examples/http_request/README.md | 1 - _examples/http_responsewriter/README.md | 1 - .../0_docs.png | Bin .../1_create_topic.png | Bin .../2_list_topics.png | Bin .../3_store_to_topic.png | Bin .../4_retrieve_from_topic_real_time.png | Bin _examples/kafka-api/Dockerfile | 17 + _examples/kafka-api/README.md | 33 + _examples/kafka-api/docker-compose.yml | 29 + .../{tutorial/docker => kafka-api}/go.mod | 3 +- .../src => kafka-api}/main.go | 56 +- .../file-logger/main.go | 34 +- _examples/logging/json-logger/main.go | 87 + .../request-logger/main.go | 0 .../request-logger-file-json/main.go | 3 - .../request-logger-file/main.go | 3 +- .../folder_structure.png | Bin .../login-mvc-single-responsibility}/main.go | 27 +- .../public/css/site.css | 120 +- .../user/auth.go | 0 .../user/controller.go | 4 +- .../user/datasource.go | 0 .../user/model.go | 0 .../views/shared/error.html | 6 +- .../views/shared/layout.html | 22 +- .../views/user/login.html | 20 +- .../views/user/me.html | 4 +- .../views/user/notfound.html | 4 +- .../views/user/register.html | 26 +- .../login/web/controllers/users_controller.go | 6 +- .../vuejs-todo-mvc/README.md | 6 +- .../vuejs-todo-mvc/screen.png | Bin .../vuejs-todo-mvc/src/todo/item.go | 0 .../vuejs-todo-mvc/src/todo/service.go | 0 .../src/web/controllers/todo_controller.go | 2 +- .../vuejs-todo-mvc/src/web/main.go | 4 +- .../vuejs-todo-mvc/src/web/public/css/index | 0 .../vuejs-todo-mvc/src/web/public/index.html | 0 .../vuejs-todo-mvc/src/web/public/js/app.js | 0 .../vuejs-todo-mvc/src/web/public/js/lib/vue | 0 _examples/{miscellaneous => }/pprof/main.go | 0 _examples/{miscellaneous => }/recover/main.go | 0 .../read-body/main.go | 22 +- .../read-body/main_test.go | 0 .../read-custom-per-type/main.go | 2 +- .../read-custom-per-type/main_test.go | 0 .../read-custom-via-unmarshaler/main.go | 0 .../read-custom-via-unmarshaler/main_test.go | 0 .../read-form/main.go | 0 .../read-form/templates/form.html | 44 +- .../read-gzip/main.go | 0 .../read-gzip/main_test.go | 0 .../read-json-struct-validation/main.go | 0 .../read-json/main.go | 0 .../read-many/main.go | 0 .../read-msgpack/main.go | 2 +- .../read-query/main.go | 0 .../read-xml/main.go | 0 .../read-xml/main_test.go | 0 .../read-yaml/main.go | 0 .../read-yaml/main_test.go | 0 .../ratelimit => request-ratelimit}/main.go | 2 + .../main.go | 8 +- .../cache/client-side/main.go | 0 .../cache/simple/main.go | 0 .../content-negotiation/main.go | 0 .../content-negotiation/main_test.go | 0 .../sse-third-party/main.go | 0 .../sse/main.go | 5 +- .../sse/optional.sse.mini.js.html | 0 .../stream-writer/main.go | 0 .../transactions/main.go | 0 .../write-gzip/main.go | 0 .../write-rest/main.go | 2 +- .../docker => routing/basic}/.dockerignore | 0 .../docker => routing/basic}/Dockerfile | 0 .../docker => routing/basic}/README.md | 2 +- .../basic}/docker-compose.yml | 0 _examples/routing/basic/main.go | 2 +- _examples/routing/basic/main_test.go | 2 +- _examples/{ => routing}/hello-world/main.go | 0 .../{overview => routing/overview-2}/main.go | 0 .../views/user/create_verification.html | 44 +- .../overview-2}/views/user/profile.html | 14 +- _examples/routing/overview/main.go | 2 +- _examples/{ => routing}/sitemap/main.go | 0 _examples/{ => routing}/sitemap/main_test.go | 0 .../{ => routing}/subdomains/multi/hosts | 56 +- .../{ => routing}/subdomains/multi/main.go | 0 .../multi/public/assets/images/test.ico | Bin .../multi/public/upload_resources/favicon.ico | Bin .../{ => routing}/subdomains/redirect/hosts | 0 .../{ => routing}/subdomains/redirect/main.go | 0 .../subdomains/redirect/main_test.go | 0 .../{ => routing}/subdomains/single/hosts | 54 +- .../{ => routing}/subdomains/single/main.go | 0 .../{ => routing}/subdomains/wildcard/hosts | 60 +- .../{ => routing}/subdomains/wildcard/main.go | 2 +- _examples/{ => routing}/subdomains/www/hosts | 50 +- .../{ => routing}/subdomains/www/main.go | 0 .../{ => routing}/subdomains/www/main_test.go | 0 _examples/{ => routing}/versioning/main.go | 0 .../structuring/bootstrap/routes/routes.go | 13 - _examples/structuring/login-mvc/README.md | 1 - .../README.md | 1 - .../tutorial/api-for-apache-kafka/README.md | 21 - _examples/tutorial/docker/main.go | 26 - .../{tutorial => }/url-shortener/README.md | 0 .../{tutorial => }/url-shortener/factory.go | 0 .../{tutorial => }/url-shortener/main.go | 2 +- .../{tutorial => }/url-shortener/main_test.go | 0 .../url-shortener/resources/css/style.css | 4 +- .../{tutorial => }/url-shortener/store.go | 0 .../url-shortener/templates/index.html | 48 +- .../herotemplate/README.md | 0 .../herotemplate/app.go | 2 +- .../herotemplate/template/index.html | 0 .../herotemplate/template/index.html.go | 0 .../herotemplate/template/user.html | 0 .../herotemplate/template/user.html.go | 0 .../herotemplate/template/userlist.html | 0 .../herotemplate/template/userlist.html.go | 0 .../herotemplate/template/userlistwriter.html | 0 .../template/userlistwriter.html.go | 0 .../quicktemplate/README.md | 0 .../controllers/execute_template.go | 2 +- .../quicktemplate/controllers/hello.go | 2 +- .../quicktemplate/controllers/index.go | 2 +- .../quicktemplate/main.go | 2 +- .../quicktemplate/main_test.go | 0 _examples/view/quicktemplate/models/.gitkeep | 0 .../quicktemplate/templates/base.qtpl | 0 .../quicktemplate/templates/base.qtpl.go | 0 .../quicktemplate/templates/hello.qtpl | 0 .../quicktemplate/templates/hello.qtpl.go | 0 .../quicktemplate/templates/index.qtpl | 0 .../quicktemplate/templates/index.qtpl.go | 0 .../{basic => }/client/go-wasm-runtime.js | 0 .../webassembly/{basic => }/client/hello.html | 0 .../{basic => }/client/hello_go114.go | 0 .../webassembly/{basic => }/client/main.js | 0 _examples/webassembly/{basic => }/main.go | 0 .../online-visitors/main.go | 0 .../static/assets/js/visitors.js | 48 +- .../online-visitors/templates/index.html | 84 +- .../online-visitors/templates/other.html | 56 +- aliases.go | 2 +- cache/cache.go | 2 +- configuration.go | 4 +- context/context.go | 48 +- core/router/handler.go | 9 +- .../router_subdomain_redirect_wrapper.go | 2 +- go.mod | 2 +- hero/handler_test.go | 2 +- iris.go | 12 +- middleware/README.md | 23 +- middleware/basicauth/basicauth.go | 4 +- middleware/hcaptcha/hcaptcha.go | 2 +- middleware/jwt/alises.go | 9 + middleware/jwt/jwt.go | 148 +- middleware/jwt/jwt_test.go | 28 +- middleware/logger/logger.go | 2 +- middleware/pprof/pprof.go | 2 +- middleware/rate/rate.go | 2 +- middleware/recover/recover.go | 2 +- middleware/requestid/requestid.go | 11 +- middleware/requestid/requestid_test.go | 4 +- mvc/controller_method_parser.go | 2 +- view/README.md | 4 +- 328 files changed, 4262 insertions(+), 41621 deletions(-) create mode 100644 _examples/apidoc/swagger/README.md rename _examples/{authentication => auth}/basicauth/main.go (100%) rename _examples/{authentication => auth}/basicauth/main_test.go (100%) rename _examples/{authentication/oauth2 => auth/goth}/main.go (100%) rename _examples/{authentication/oauth2 => auth/goth}/templates/index.html (93%) rename _examples/{authentication/oauth2 => auth/goth}/templates/user.html (88%) rename _examples/{miscellaneous => auth}/hcaptcha/hosts (100%) rename _examples/{miscellaneous => auth}/hcaptcha/main.go (100%) rename _examples/{miscellaneous => auth}/hcaptcha/templates/register_form.html (100%) rename _examples/{miscellaneous => auth}/jwt/README.md (100%) rename _examples/{miscellaneous => auth}/jwt/main.go (95%) rename _examples/{miscellaneous => auth}/jwt/rsa_password_protected.key (100%) rename _examples/{ => auth}/permissions/main.go (100%) rename _examples/{miscellaneous => auth}/recaptcha/custom_form/main.go (100%) rename _examples/{miscellaneous => auth}/recaptcha/main.go (100%) delete mode 100644 _examples/authentication/README.md rename _examples/{structuring => }/bootstrap/bootstrap/bootstrapper.go (100%) rename _examples/{structuring => }/bootstrap/folder_structure.png (100%) rename _examples/{structuring => }/bootstrap/main.go (54%) rename _examples/{structuring => }/bootstrap/main_test.go (81%) rename _examples/{structuring => }/bootstrap/middleware/identity/identity.go (91%) rename _examples/{structuring => }/bootstrap/public/favicon.ico (100%) rename _examples/{structuring => }/bootstrap/routes/follower.go (100%) rename _examples/{structuring => }/bootstrap/routes/following.go (100%) rename _examples/{structuring => }/bootstrap/routes/index.go (100%) rename _examples/{structuring => }/bootstrap/routes/like.go (100%) create mode 100644 _examples/bootstrap/routes/routes.go rename _examples/{structuring => }/bootstrap/views/index.html (100%) rename _examples/{structuring => }/bootstrap/views/shared/error.html (83%) rename _examples/{structuring => }/bootstrap/views/shared/layout.html (94%) rename _examples/{tutorial => }/caddy/Caddyfile (95%) rename _examples/{tutorial => }/caddy/README.md (77%) rename _examples/{tutorial => }/caddy/server1/main.go (100%) rename _examples/{tutorial => }/caddy/server1/views/index.html (74%) rename _examples/{tutorial => }/caddy/server1/views/shared/layout.html (84%) rename _examples/{tutorial => }/caddy/server2/main.go (96%) rename _examples/{tutorial => database}/mongodb/.env (100%) rename _examples/{tutorial => database}/mongodb/0_create_movie.png (100%) rename _examples/{tutorial => database}/mongodb/1_update_movie.png (100%) rename _examples/{tutorial => database}/mongodb/2_get_all_movies.png (100%) rename _examples/{tutorial => database}/mongodb/3_get_movie.png (100%) rename _examples/{tutorial => database}/mongodb/4_delete_movie.png (100%) create mode 100644 _examples/database/mongodb/Dockerfile rename _examples/{tutorial => database}/mongodb/README.md (86%) rename _examples/{tutorial => database}/mongodb/api/store/movie.go (94%) create mode 100644 _examples/database/mongodb/docker-compose.yml rename _examples/{tutorial => database}/mongodb/env/env.go (64%) create mode 100644 _examples/database/mongodb/go.mod rename _examples/{tutorial => database}/mongodb/httputil/error.go (100%) rename _examples/{tutorial => database}/mongodb/main.go (88%) rename _examples/{tutorial => database}/mongodb/store/movie.go (100%) create mode 100644 _examples/database/mysql/Dockerfile create mode 100644 _examples/database/mysql/README.md create mode 100644 _examples/database/mysql/api/api.go create mode 100644 _examples/database/mysql/api/category_handler.go create mode 100644 _examples/database/mysql/api/helper.go create mode 100644 _examples/database/mysql/api/httperror.go rename _examples/{http_request/upload-file/uploads => database/mysql/api/middleware}/.gitkeep (100%) create mode 100644 _examples/database/mysql/api/product_handler.go create mode 100644 _examples/database/mysql/cache/groupcache.go create mode 100644 _examples/database/mysql/docker-compose.yml create mode 100644 _examples/database/mysql/entity/category.go create mode 100644 _examples/database/mysql/entity/product.go create mode 100644 _examples/database/mysql/go.mod create mode 100644 _examples/database/mysql/main.go create mode 100644 _examples/database/mysql/migration/api_category/create_category.json create mode 100644 _examples/database/mysql/migration/api_category/insert_products_category.json create mode 100644 _examples/database/mysql/migration/api_category/update_category.json create mode 100644 _examples/database/mysql/migration/api_category/update_partial_category.json create mode 100644 _examples/database/mysql/migration/api_postman.json create mode 100644 _examples/database/mysql/migration/api_product/create_product.json create mode 100644 _examples/database/mysql/migration/api_product/update_partial_product.json create mode 100644 _examples/database/mysql/migration/api_product/update_product.json create mode 100644 _examples/database/mysql/migration/db.sql create mode 100644 _examples/database/mysql/service/category_service.go create mode 100644 _examples/database/mysql/service/category_service_test.go create mode 100644 _examples/database/mysql/service/product_service.go create mode 100644 _examples/database/mysql/sql/mysql.go create mode 100644 _examples/database/mysql/sql/service.go create mode 100644 _examples/database/mysql/sql/sql.go rename _examples/{ => database}/orm/gorm/REAMDE.md (100%) rename _examples/{ => database}/orm/gorm/main.go (100%) rename _examples/{ => database}/orm/xorm/main.go (100%) create mode 100644 _examples/dependency-injection/jwt/contrib/main.go rename _examples/{desktop-app => desktop}/blink/main.go (100%) rename _examples/{desktop-app => desktop}/lorca/main.go (100%) rename _examples/{desktop-app => desktop}/webview/main.go (100%) rename _examples/{tutorial => }/dropzonejs/README.md (96%) rename _examples/{tutorial => }/dropzonejs/README_PART2.md (96%) rename _examples/{tutorial => }/dropzonejs/folder_structure.png (100%) rename _examples/{tutorial => }/dropzonejs/meta.yml (100%) rename _examples/{tutorial => }/dropzonejs/no_files.png (100%) rename _examples/{tutorial => }/dropzonejs/src/main.go (100%) rename _examples/{tutorial => }/dropzonejs/src/public/css/dropzone.css (100%) rename _examples/{tutorial => }/dropzonejs/src/public/js/dropzone.js (100%) rename _examples/{tutorial => }/dropzonejs/src/views/upload.html (96%) rename _examples/{tutorial => }/dropzonejs/with_files.png (100%) delete mode 100644 _examples/experimental-handlers/README.md delete mode 100644 _examples/experimental-handlers/casbin/middleware/casbinmodel.conf delete mode 100644 _examples/experimental-handlers/casbin/middleware/casbinpolicy.csv delete mode 100644 _examples/experimental-handlers/casbin/middleware/main.go delete mode 100644 _examples/experimental-handlers/casbin/middleware/main_test.go delete mode 100644 _examples/experimental-handlers/casbin/wrapper/casbinmodel.conf delete mode 100644 _examples/experimental-handlers/casbin/wrapper/casbinpolicy.csv delete mode 100644 _examples/experimental-handlers/casbin/wrapper/main.go delete mode 100644 _examples/experimental-handlers/casbin/wrapper/main_test.go delete mode 100644 _examples/experimental-handlers/cloudwatch/simple/main.go delete mode 100644 _examples/experimental-handlers/cors/simple/client/index.html delete mode 100644 _examples/experimental-handlers/cors/simple/client/main.go delete mode 100644 _examples/experimental-handlers/cors/simple/main.go delete mode 100644 _examples/experimental-handlers/csrf/main.go delete mode 100644 _examples/experimental-handlers/csrf/views/user/signup.html delete mode 100644 _examples/experimental-handlers/jwt/main.go delete mode 100644 _examples/experimental-handlers/newrelic/simple/main.go delete mode 100644 _examples/experimental-handlers/prometheus/simple/main.go delete mode 100644 _examples/experimental-handlers/secure/simple/main.go delete mode 100644 _examples/experimental-handlers/tollboothic/limit-handler/main.go rename _examples/{http_request => file-server}/upload-file/main.go (100%) rename _examples/{http_request => file-server}/upload-file/templates/upload_form.html (100%) rename _examples/{http_request/upload-files => file-server/upload-file}/uploads/.gitkeep (100%) rename _examples/{http_request => file-server}/upload-files/main.go (100%) rename _examples/{http_request => file-server}/upload-files/main_test.go (100%) rename _examples/{http_request => file-server}/upload-files/templates/upload_form.html (96%) rename _examples/{http_responsewriter/quicktemplate/models => file-server/upload-files/uploads}/.gitkeep (100%) rename _examples/{http-listening => http-server}/README.md (100%) rename _examples/{http-listening => http-server}/custom-httpserver/easy-way/main.go (100%) rename _examples/{http-listening => http-server}/custom-httpserver/multi/main.go (100%) rename _examples/{http-listening => http-server}/custom-httpserver/std-way/main.go (100%) rename _examples/{http-listening => http-server}/custom-listener/main.go (100%) rename _examples/{http-listening => http-server}/custom-listener/unix-reuseport/main.go (100%) rename _examples/{http-listening => http-server}/custom-listener/unix-reuseport/main_windows.go (100%) rename _examples/{http-listening => http-server}/graceful-shutdown/custom-notifier/main.go (100%) rename _examples/{http-listening => http-server}/graceful-shutdown/default-notifier/main.go (100%) rename _examples/{http-listening => http-server}/http3-quic/go.mod (50%) rename _examples/{http-listening => http-server}/http3-quic/localhost.cert (100%) rename _examples/{http-listening => http-server}/http3-quic/localhost.key (100%) rename _examples/{http-listening => http-server}/http3-quic/main.go (100%) rename _examples/{http-listening => http-server}/iris-configurator-and-host-configurator/main.go (100%) rename _examples/{http-listening => http-server}/listen-addr-public/main.go (100%) rename _examples/{http-listening => http-server}/listen-addr/main.go (100%) rename _examples/{http-listening => http-server}/listen-addr/omit-server-errors/main.go (100%) rename _examples/{http-listening => http-server}/listen-addr/omit-server-errors/main_test.go (100%) rename _examples/{http-listening => http-server}/listen-letsencrypt/main.go (100%) rename _examples/{http-listening => http-server}/listen-tls/main.go (100%) rename _examples/{http-listening => http-server}/listen-tls/mycert.cert (98%) rename _examples/{http-listening => http-server}/listen-tls/mykey.key (98%) rename _examples/{http-listening => http-server}/listen-unix/main.go (100%) rename _examples/{http-listening => http-server}/notify-on-shutdown/main.go (100%) delete mode 100644 _examples/http_request/README.md delete mode 100644 _examples/http_responsewriter/README.md rename _examples/{tutorial/api-for-apache-kafka => kafka-api}/0_docs.png (100%) rename _examples/{tutorial/api-for-apache-kafka => kafka-api}/1_create_topic.png (100%) rename _examples/{tutorial/api-for-apache-kafka => kafka-api}/2_list_topics.png (100%) rename _examples/{tutorial/api-for-apache-kafka => kafka-api}/3_store_to_topic.png (100%) rename _examples/{tutorial/api-for-apache-kafka => kafka-api}/4_retrieve_from_topic_real_time.png (100%) create mode 100644 _examples/kafka-api/Dockerfile create mode 100644 _examples/kafka-api/README.md create mode 100644 _examples/kafka-api/docker-compose.yml rename _examples/{tutorial/docker => kafka-api}/go.mod (55%) rename _examples/{tutorial/api-for-apache-kafka/src => kafka-api}/main.go (90%) rename _examples/{miscellaneous => logging}/file-logger/main.go (100%) create mode 100644 _examples/logging/json-logger/main.go rename _examples/{http_request => logging}/request-logger/main.go (100%) rename _examples/{http_request => logging}/request-logger/request-logger-file-json/main.go (97%) rename _examples/{http_request => logging}/request-logger/request-logger-file/main.go (96%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/folder_structure.png (100%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/main.go (62%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/public/css/site.css (94%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/user/auth.go (100%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/user/controller.go (98%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/user/datasource.go (100%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/user/model.go (100%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/views/shared/error.html (75%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/views/shared/layout.html (89%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/views/user/login.html (95%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/views/user/me.html (90%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/views/user/notfound.html (91%) rename _examples/{structuring/login-mvc-single-responsibility-package => mvc/login-mvc-single-responsibility}/views/user/register.html (96%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/README.md (98%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/screen.png (100%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/src/todo/item.go (100%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/src/todo/service.go (100%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/src/web/controllers/todo_controller.go (96%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/src/web/main.go (91%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/src/web/public/css/index (100%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/src/web/public/index.html (100%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/src/web/public/js/app.js (100%) rename _examples/{tutorial => mvc}/vuejs-todo-mvc/src/web/public/js/lib/vue (100%) rename _examples/{miscellaneous => }/pprof/main.go (100%) rename _examples/{miscellaneous => }/recover/main.go (100%) rename _examples/{http_request => request-body}/read-body/main.go (100%) rename _examples/{http_request => request-body}/read-body/main_test.go (100%) rename _examples/{http_request => request-body}/read-custom-per-type/main.go (96%) rename _examples/{http_request => request-body}/read-custom-per-type/main_test.go (100%) rename _examples/{http_request => request-body}/read-custom-via-unmarshaler/main.go (100%) rename _examples/{http_request => request-body}/read-custom-via-unmarshaler/main_test.go (100%) rename _examples/{http_request => request-body}/read-form/main.go (100%) rename _examples/{http_request => request-body}/read-form/templates/form.html (96%) rename _examples/{http_request => request-body}/read-gzip/main.go (100%) rename _examples/{http_request => request-body}/read-gzip/main_test.go (100%) rename _examples/{http_request => request-body}/read-json-struct-validation/main.go (100%) rename _examples/{http_request => request-body}/read-json/main.go (100%) rename _examples/{http_request => request-body}/read-many/main.go (100%) rename _examples/{http_request => request-body}/read-msgpack/main.go (89%) rename _examples/{http_request => request-body}/read-query/main.go (100%) rename _examples/{http_request => request-body}/read-xml/main.go (100%) rename _examples/{http_request => request-body}/read-xml/main_test.go (100%) rename _examples/{http_request => request-body}/read-yaml/main.go (100%) rename _examples/{http_request => request-body}/read-yaml/main_test.go (100%) rename _examples/{miscellaneous/ratelimit => request-ratelimit}/main.go (96%) rename _examples/{http_request/extract-referer => request-referrer}/main.go (65%) rename _examples/{ => response-writer}/cache/client-side/main.go (100%) rename _examples/{ => response-writer}/cache/simple/main.go (100%) rename _examples/{http_responsewriter => response-writer}/content-negotiation/main.go (100%) rename _examples/{http_responsewriter => response-writer}/content-negotiation/main_test.go (100%) rename _examples/{http_responsewriter => response-writer}/sse-third-party/main.go (100%) rename _examples/{http_responsewriter => response-writer}/sse/main.go (98%) rename _examples/{http_responsewriter => response-writer}/sse/optional.sse.mini.js.html (100%) rename _examples/{http_responsewriter => response-writer}/stream-writer/main.go (100%) rename _examples/{http_responsewriter => response-writer}/transactions/main.go (100%) rename _examples/{http_responsewriter => response-writer}/write-gzip/main.go (100%) rename _examples/{http_responsewriter => response-writer}/write-rest/main.go (98%) rename _examples/{tutorial/docker => routing/basic}/.dockerignore (100%) rename _examples/{tutorial/docker => routing/basic}/Dockerfile (100%) rename _examples/{tutorial/docker => routing/basic}/README.md (97%) rename _examples/{tutorial/docker => routing/basic}/docker-compose.yml (100%) rename _examples/{ => routing}/hello-world/main.go (100%) rename _examples/{overview => routing/overview-2}/main.go (100%) rename _examples/{overview => routing/overview-2}/views/user/create_verification.html (96%) rename _examples/{overview => routing/overview-2}/views/user/profile.html (95%) rename _examples/{ => routing}/sitemap/main.go (100%) rename _examples/{ => routing}/sitemap/main_test.go (100%) rename _examples/{ => routing}/subdomains/multi/hosts (97%) rename _examples/{ => routing}/subdomains/multi/main.go (100%) rename _examples/{ => routing}/subdomains/multi/public/assets/images/test.ico (100%) rename _examples/{ => routing}/subdomains/multi/public/upload_resources/favicon.ico (100%) rename _examples/{ => routing}/subdomains/redirect/hosts (100%) rename _examples/{ => routing}/subdomains/redirect/main.go (100%) rename _examples/{ => routing}/subdomains/redirect/main_test.go (100%) rename _examples/{ => routing}/subdomains/single/hosts (97%) rename _examples/{ => routing}/subdomains/single/main.go (100%) rename _examples/{ => routing}/subdomains/wildcard/hosts (97%) rename _examples/{ => routing}/subdomains/wildcard/main.go (95%) rename _examples/{ => routing}/subdomains/www/hosts (97%) rename _examples/{ => routing}/subdomains/www/main.go (100%) rename _examples/{ => routing}/subdomains/www/main_test.go (100%) rename _examples/{ => routing}/versioning/main.go (100%) delete mode 100644 _examples/structuring/bootstrap/routes/routes.go delete mode 100644 _examples/structuring/login-mvc/README.md delete mode 100644 _examples/structuring/mvc-plus-repository-and-service-layers/README.md delete mode 100644 _examples/tutorial/api-for-apache-kafka/README.md delete mode 100644 _examples/tutorial/docker/main.go rename _examples/{tutorial => }/url-shortener/README.md (100%) rename _examples/{tutorial => }/url-shortener/factory.go (100%) rename _examples/{tutorial => }/url-shortener/main.go (97%) rename _examples/{tutorial => }/url-shortener/main_test.go (100%) rename _examples/{tutorial => }/url-shortener/resources/css/style.css (92%) rename _examples/{tutorial => }/url-shortener/store.go (100%) rename _examples/{tutorial => }/url-shortener/templates/index.html (95%) rename _examples/{http_responsewriter => view}/herotemplate/README.md (100%) rename _examples/{http_responsewriter => view}/herotemplate/app.go (93%) rename _examples/{http_responsewriter => view}/herotemplate/template/index.html (100%) rename _examples/{http_responsewriter => view}/herotemplate/template/index.html.go (100%) rename _examples/{http_responsewriter => view}/herotemplate/template/user.html (100%) rename _examples/{http_responsewriter => view}/herotemplate/template/user.html.go (100%) rename _examples/{http_responsewriter => view}/herotemplate/template/userlist.html (100%) rename _examples/{http_responsewriter => view}/herotemplate/template/userlist.html.go (100%) rename _examples/{http_responsewriter => view}/herotemplate/template/userlistwriter.html (100%) rename _examples/{http_responsewriter => view}/herotemplate/template/userlistwriter.html.go (100%) rename _examples/{http_responsewriter => view}/quicktemplate/README.md (100%) rename _examples/{http_responsewriter => view}/quicktemplate/controllers/execute_template.go (78%) rename _examples/{http_responsewriter => view}/quicktemplate/controllers/hello.go (90%) rename _examples/{http_responsewriter => view}/quicktemplate/controllers/index.go (76%) rename _examples/{http_responsewriter => view}/quicktemplate/main.go (78%) rename _examples/{http_responsewriter => view}/quicktemplate/main_test.go (100%) create mode 100644 _examples/view/quicktemplate/models/.gitkeep rename _examples/{http_responsewriter => view}/quicktemplate/templates/base.qtpl (100%) rename _examples/{http_responsewriter => view}/quicktemplate/templates/base.qtpl.go (100%) rename _examples/{http_responsewriter => view}/quicktemplate/templates/hello.qtpl (100%) rename _examples/{http_responsewriter => view}/quicktemplate/templates/hello.qtpl.go (100%) rename _examples/{http_responsewriter => view}/quicktemplate/templates/index.qtpl (100%) rename _examples/{http_responsewriter => view}/quicktemplate/templates/index.qtpl.go (100%) rename _examples/webassembly/{basic => }/client/go-wasm-runtime.js (100%) rename _examples/webassembly/{basic => }/client/hello.html (100%) rename _examples/webassembly/{basic => }/client/hello_go114.go (100%) rename _examples/webassembly/{basic => }/client/main.js (100%) rename _examples/webassembly/{basic => }/main.go (100%) rename _examples/{tutorial => websocket}/online-visitors/main.go (100%) rename _examples/{tutorial => websocket}/online-visitors/static/assets/js/visitors.js (96%) rename _examples/{tutorial => websocket}/online-visitors/templates/index.html (95%) rename _examples/{tutorial => websocket}/online-visitors/templates/other.html (94%) diff --git a/HISTORY.md b/HISTORY.md index 86a57125..7969a284 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -159,7 +159,7 @@ Prior to this version the `iris.Context` was the only one dependency that has be | `float, float32, float64`, | | | `bool`, | | | `slice` | [Path Parameter](https://github.com/kataras/iris/wiki/Routing-path-parameter-types) | -| Struct | [Request Body](https://github.com/kataras/iris/tree/master/_examples/http_request) of `JSON`, `XML`, `YAML`, `Form`, `URL Query`, `Protobuf`, `MsgPack` | +| Struct | [Request Body](https://github.com/kataras/iris/tree/master/_examples/request-body) of `JSON`, `XML`, `YAML`, `Form`, `URL Query`, `Protobuf`, `MsgPack` | Here is a preview of what the new Hero handlers look like: @@ -393,7 +393,7 @@ Other Improvements: - New `iris.WithLowercaseRouting` option which forces all routes' paths to be lowercase and converts request paths to their lowercase for matching. -- New `app.Validator { Struct(interface{}) error }` field and `app.Validate` method were added. The `app.Validator = ` can be used to integrate a 3rd-party package such as [go-playground/validator](https://github.com/go-playground/validator). If set-ed then Iris `Context`'s `ReadJSON`, `ReadXML`, `ReadMsgPack`, `ReadYAML`, `ReadForm`, `ReadQuery`, `ReadBody` methods will return the validation error on data validation failures. The [read-json-struct-validation](_examples/http_request/read-json-struct-validation) example was updated. +- New `app.Validator { Struct(interface{}) error }` field and `app.Validate` method were added. The `app.Validator = ` can be used to integrate a 3rd-party package such as [go-playground/validator](https://github.com/go-playground/validator). If set-ed then Iris `Context`'s `ReadJSON`, `ReadXML`, `ReadMsgPack`, `ReadYAML`, `ReadForm`, `ReadQuery`, `ReadBody` methods will return the validation error on data validation failures. The [read-json-struct-validation](_examples/request-body/read-json-struct-validation) example was updated. - A result of can implement the new `hero.PreflightResult` interface which contains a single method of `Preflight(iris.Context) error`. If this method exists on a custom struct value which is returned from a handler then it will fire that `Preflight` first and if not errored then it will cotninue by sending the struct value as JSON(by-default) response body. @@ -415,7 +415,7 @@ New Package-level Variables: New Context Methods: -- `Context.GzipReader(enable bool)` method and `iris.GzipReader` middleware to enable future request read body calls to decompress data using gzip, [example](_examples/http_request/read-gzip). +- `Context.GzipReader(enable bool)` method and `iris.GzipReader` middleware to enable future request read body calls to decompress data using gzip, [example](_examples/request-body/read-gzip). - `Context.RegisterDependency(v interface{})` and `Context.RemoveDependency(typ reflect.Type)` to register/remove struct dependencies on serve-time through a middleware. - `Context.SetID(id interface{})` and `Context.GetID() interface{}` added to register a custom unique indetifier to the Context, if necessary. - `Context.GetDomain() string` returns the domain. @@ -476,7 +476,6 @@ Implement **new** `SetRegisterRule(iris.RouteOverride, RouteSkip, RouteError)` t New Examples: -- [_examples/Docker](_examples/Docker) - [_examples/routing/route-register-rule](_examples/routing/route-register-rule) # We, 05 February 2020 | v12.1.6 @@ -570,10 +569,10 @@ Navigate through: https://github.com/kataras/iris/wiki/Sitemap for more. ## New Examples 2. [_examples/i18n](_examples/i18n) -1. [_examples/sitemap](_examples/sitemap) -3. [_examples/desktop-app/blink](_examples/desktop-app/blink) -4. [_examples/desktop-app/lorca](_examples/desktop-app/lorca) -5. [_examples/desktop-app/webview](_examples/desktop-app/webview) +1. [_examples/sitemap](_examples/routing/sitemap) +3. [_examples/desktop/blink](_examples/desktop/blink) +4. [_examples/desktop/lorca](_examples/desktop/lorca) +5. [_examples/desktop/webview](_examples/desktop/webview) # Sa, 26 October 2019 | v12.0.0 @@ -603,7 +602,7 @@ The iris-contrib/middleare and examples are updated to use the new `github.com/k # Fr, 16 August 2019 | v11.2.8 - Set `Cookie.SameSite` to `Lax` when subdomains sessions share is enabled[*](https://github.com/kataras/iris/commit/6bbdd3db9139f9038641ce6f00f7b4bab6e62550) -- Add and update all [experimental handlers](https://github.com/kataras/iris/tree/master/_examples/experimental-handlers) +- Add and update all [experimental handlers](https://github.com/iris-contrib/middleware) - New `XMLMap` function which wraps a `map[string]interface{}` and converts it to a valid xml content to render through `Context.XML` method - Add new `ProblemOptions.XML` and `RenderXML` fields to render the `Problem` as XML(application/problem+xml) instead of JSON("application/problem+json) and enrich the `Negotiate` to easily accept the `application/problem+xml` mime. @@ -657,7 +656,7 @@ Commit log: https://github.com/kataras/iris/compare/v11.2.3...v11.2.4 - [New Feature: Handle different parameter types in the same path](https://github.com/kataras/iris/issues/1315) - [New Feature: Content Negotiation](https://github.com/kataras/iris/issues/1319) -- [Context.ReadYAML](https://github.com/kataras/iris/tree/master/_examples/http_request/read-yaml) +- [Context.ReadYAML](https://github.com/kataras/iris/tree/master/_examples/request-body/read-yaml) - Fixes https://github.com/kataras/neffos/issues/1#issuecomment-515698536 # We, 24 July 2019 | v11.2.2 diff --git a/HISTORY_ES.md b/HISTORY_ES.md index ccdaa84a..20cc3398 100644 --- a/HISTORY_ES.md +++ b/HISTORY_ES.md @@ -108,7 +108,7 @@ Registro de commits: https://github.com/kataras/iris/compare/v11.2.3...v11.2.4 - [Nueva característica: Manejar diferentes tipos de parámetros en la misma ruta](https://github.com/kataras/iris/issues/1315) - [Nueva característica: Negociación de contenido](https://github.com/kataras/iris/issues/1319) -- [Context.ReadYAML](https://github.com/kataras/iris/tree/master/_examples/http_request/read-yaml) +- [Context.ReadYAML](https://github.com/kataras/iris/tree/master/_examples/request-body/read-yaml) - Ajustes https://github.com/kataras/neffos/issues/1#issuecomment-515698536 # Miércoles, 24 de julio 2019 | v11.2.2 diff --git a/_examples/README.md b/_examples/README.md index 3f6c3386..d44f4ece 100644 --- a/_examples/README.md +++ b/_examples/README.md @@ -1,31 +1,30 @@ # Table of Contents -* Tutorials - * [Dockerize](tutorial/docker) - * [Caddy](tutorial/caddy) - * [MongoDB](tutorial/mongodb) - * [Dropzone.js](tutorial/dropzonejs) - * [URL Shortener](tutorial/url-shortener/main.go) - * [Online Visitors](tutorial/online-visitors/main.go) - * [REST API for Apache Kafka](tutorial/api-for-apache-kafka) - * [Vue.js Todo (MVC)](tutorial/vuejs-todo-mvc) - * [gRPC (MVC)](mvc/grpc-compatible) -* HTTP Listening - * [HOST:PORT](http-listening/listen-addr/main.go) - * [Public Test Domain](http-listening/listen-addr-public/main.go) - * [UNIX socket file](http-listening/listen-unix/main.go) - * [TLS](http-listening/listen-tls/main.go) - * [Letsencrypt (Automatic Certifications)](http-listening/listen-letsencrypt/main.go) - * [Graceful Shutdown](http-listening/graceful-shutdown/default-notifier/main.go) - * [Notify on shutdown](http-listening/notify-on-shutdown/main.go) +* [REST API for Apache Kafka](kafka-api) +* [URL Shortener](url-shortener) +* [Dropzone.js](dropzonejs) +* [Caddy](caddy) +* Database + * [MySQL, Groupcache & Docker](database/mysql) + * [MongoDB](database/mongodb) + * [Xorm](database/orm/xorm/main.go) + * [Gorm](database/orm/gorm/main.go) +* HTTP Server + * [HOST:PORT](http-server/listen-addr/main.go) + * [Public Test Domain](http-server/listen-addr-public/main.go) + * [UNIX socket file](http-server/listen-unix/main.go) + * [TLS](http-server/listen-tls/main.go) + * [Letsencrypt (Automatic Certifications)](http-server/listen-letsencrypt/main.go) + * [Graceful Shutdown](http-server/graceful-shutdown/default-notifier/main.go) + * [Notify on shutdown](http-server/notify-on-shutdown/main.go) * Custom TCP Listener - * [Common net.Listener](http-listening/custom-listener/main.go) - * [SO_REUSEPORT for unix systems](http-listening/custom-listener/unix-reuseport/main.go) + * [Common net.Listener](http-server/custom-listener/main.go) + * [SO_REUSEPORT for unix systems](http-server/custom-listener/unix-reuseport/main.go) * Custom HTTP Server - * [Pass a custom Server](http-listening/custom-httpserver/easy-way/main.go) - * [Use Iris as a single http.Handler](http-listening/custom-httpserver/std-way/main.go) - * [Multi Instances](http-listening/custom-httpserver/multi/main.go) - * [HTTP/3 Quic](http-listening/http3-quic) + * [Pass a custom Server](http-server/custom-httpserver/easy-way/main.go) + * [Use Iris as a single http.Handler](http-server/custom-httpserver/std-way/main.go) + * [Multi Instances](http-server/custom-httpserver/multi/main.go) + * [HTTP/3 Quic](http-server/http3-quic) * Configuration * [Functional](configuration/functional/main.go) * [Configuration Struct](configuration/from-configuration-structure/main.go) @@ -56,19 +55,27 @@ * Custom Context * [Method Overriding](routing/custom-context/method-overriding/main.go) * [New Implementation](routing/custom-context/new-implementation/main.go) -* Subdomains - * [Single](subdomains/single/main.go) - * [Multi](subdomains/multi/main.go) - * [Wildcard](subdomains/wildcard/main.go) - * [WWW](subdomains/www/main.go) - * [Redirection](subdomains/redirect/main.go) -* API Versioning - * [How it works](https://github.com/kataras/iris/wiki/API-versioning) - * [Example](versioning/main.go) + * Subdomains + * [Single](routing/subdomains/single/main.go) + * [Multi](routing/subdomains/multi/main.go) + * [Wildcard](routing/subdomains/wildcard/main.go) + * [WWW](routing/subdomains/www/main.go) + * [Redirection](routing/subdomains/redirect/main.go) + * [HTTP Method Override](https://github.com/kataras/iris/blob/master/middleware/methodoverride/methodoverride_test.go) + * [API Versioning](routing/versioning/main.go) + * [Sitemap](routing/sitemap/main.go) +* Logging + * [Request Logger](logging/request-logger/main.go) + * [Log Requests to a File](logging/request-logger/request-logger-file/main.go) + * [Log Requests to a JSON File](logging/request-logger/request-logger-file-json/main.go) + * [Application File Logger](logging/file-logger/main.go) + * [Application JSON Logger](logging/json-logger/main.go) * API Documentation - * [yaag](apidoc/yaag/main.go) -* Testing - * [Example](testing/httptest/main_test.go) + * [Yaag](apidoc/yaag/main.go) + * [Swagger](https://github.com/iris-contrib/swagger/tree/master/example) +* [Testing](testing/httptest/main_test.go) +* [Recovery](recover/main.go) +* [Profiling](pprof/main.go) * File Server * [Favicon](file-server/favicon/main.go) * [Basic](file-server/basic/main.go) @@ -79,6 +86,8 @@ * [Basic SPA](file-server/single-page-application/basic/main.go) * [Embedded Single Page Application](file-server/single-page-application/embedded-single-page-application/main.go) * [Embedded Single Page Application with other routes](file-server/single-page-application/embedded-single-page-application-with-other-routes/main.go) + * [Upload File](file-server/upload-file/main.go) + * [Upload Multiple Files](file-server/upload-files/main.go) * View * [Overview](view/overview/main.go) * [Basic](view/template_html_0/main.go) @@ -93,51 +102,51 @@ * [Pug: `Actions`](view/template_pug_1) * [Pug: `Includes`](view/template_pug_2) * [Pug: `Extends`](view/template_pug_3) - * [Jet Template](/view/template_jet_0) + * [Jet Template](view/template_jet_0) * [Jet Embedded](view/template_jet_1_embedded) - * [Jet 'urlpath' tmpl func](/view/template_jet_2) - * [Jet Template Funcs from Struct](/view/template_jet_3) + * [Jet 'urlpath' tmpl func](view/template_jet_2) + * [Jet Template Funcs from Struct](view/template_jet_3) * Third-Parties - * [Render `valyala/quicktemplate` templates](http_responsewriter/quicktemplate) - * [Render `shiyanhui/hero` templates](http_responsewriter/herotemplate) + * [Render `valyala/quicktemplate` templates](view/quicktemplate) + * [Render `shiyanhui/hero` templates](view/herotemplate) +* [Request ID](https://github.com/kataras/iris/blob/master/middleware/requestid/requestid_test.go) +* [Request Rate Limit](request-ratelimit/main.go) +* [Request Referrer](request-referrer/main.go) +* [Webassembly](webassembly/basic/main.go) * Request Body - * [Bind JSON](http_request/read-json/main.go) - * * [Struct Validation](http_request/read-json-struct-validation/main.go) - * [Bind XML](http_request/read-xml/main.go) - * [Bind MsgPack](http_request/read-msgpack/main.go) - * [Bind YAML](http_request/read-yaml/main.go) - * [Bind Form](http_request/read-form/main.go) - * [Bind Query](http_request/read-query/main.go) - * [Bind Body](http_request/read-body/main.go) - * [Bind Custom per type](http_request/read-custom-per-type/main.go) - * [Bind Custom via Unmarshaler](http_request/read-custom-via-unmarshaler/main.go) - * [Bind Many times](http_request/read-many/main.go) - * [Read/Bind Gzip compressed data](http_request/read-gzip/main.go) - * [Upload/Read File](http_request/upload-file/main.go) - * [Upload multiple Files](http_request/upload-files/main.go) - * [Extract Referrer](http_request/extract-referer/main.go) + * [Bind JSON](request-body/read-json/main.go) + * * [Struct Validation](request-body/read-json-struct-validation/main.go) + * [Bind XML](request-body/read-xml/main.go) + * [Bind MsgPack](request-body/read-msgpack/main.go) + * [Bind YAML](request-body/read-yaml/main.go) + * [Bind Form](request-body/read-form/main.go) + * [Bind Query](request-body/read-query/main.go) + * [Bind Body](request-body/read-body/main.go) + * [Bind Custom per type](request-body/read-custom-per-type/main.go) + * [Bind Custom via Unmarshaler](request-body/read-custom-via-unmarshaler/main.go) + * [Bind Many times](request-body/read-many/main.go) + * [Read/Bind Gzip compressed data](request-body/read-gzip/main.go) * Response Writer - * [Content Negotiation](http_responsewriter/content-negotiation) - * [Text, Markdown, YAML, HTML, JSON, JSONP, Msgpack, XML and Binary](http_responsewriter/write-rest/main.go) - * [Write Gzip](http_responsewriter/write-gzip/main.go) - * [Stream Writer](http_responsewriter/stream-writer/main.go) - * [Transactions](http_responsewriter/transactions/main.go) - * [SSE](http_responsewriter/sse/main.go) - * [SSE (third-party package usage for server sent events)](http_responsewriter/sse-third-party/main.go) - * [Webassembly](webassembly/basic/main.go) -* Cache - * [Simple](cache/simple/main.go) - * [Client-Side (304)](cache/client-side/main.go) + * [Content Negotiation](response-writer/content-negotiation) + * [Text, Markdown, YAML, HTML, JSON, JSONP, Msgpack, XML and Binary](response-writer/write-rest/main.go) + * [Write Gzip](response-writer/write-gzip/main.go) + * [Stream Writer](response-writer/stream-writer/main.go) + * [Transactions](response-writer/transactions/main.go) + * [SSE](response-writer/sse/main.go) + * [SSE (third-party package usage for server sent events)](response-writer/sse-third-party/main.go) + * Cache + * [Simple](response-writer/simple/main.go) + * [Client-Side (304)](response-writer/client-side/main.go) * Localization and Internationalization * [i18n](i18n/main.go) -* Sitemaps - * [Sitemap](sitemap/main.go) -* Authentication - * [Basic Authentication](authentication/basicauth/main.go) - * [JWT](miscellaneous/jwt/main.go) - * [JWT (community edition)](experimental-handlers/jwt/main.go) - * [OAUth2](authentication/oauth2/main.go) - * [Manage Permissions](permissions/main.go) +* Authentication, Authorization & Bot Detection + * [Basic Authentication](auth/basicauth/main.go) + * [JWT](auth/jwt/main.go) + * [JWT (community edition)](https://github.com/iris-contrib/middleware/tree/v12/jwt/_example/main.go) + * [OAUth2](auth/goth/main.go) + * [Manage Permissions](auth/permissions/main.go) + * [Google reCAPTCHA](auth/recaptcha/main.go) + * [hCaptcha](auth/hcaptcha/main.go) * Cookies * [Basic](cookies/basic/main.go) * [Options](cookies/options/main.go) @@ -160,6 +169,7 @@ * [Browser NPM Client (browserify)](websocket/basic/browserify/app.js) * [Native Messages](websocket/native-messages/main.go) * [TLS](websocket/secure/README.md) + * [Online Visitors](websocket/online-visitors/main.go) * Dependency Injection * [Overview (Movies Service)](ependency-injection/overview/main.go) * [Basic](dependency-injection/basic/main.go) @@ -167,9 +177,9 @@ * [Sessions](dependency-injection/sessions/main.go) * [Smart Contract](dependency-injection/smart-contract/main.go) * [JWT](dependency-injection/jwt/main.go) + * [JWT (iris-contrib)](dependency-injection/jwt/contrib/main.go) * MVC * [Overview - Repository and Service layers](mvc/overview) - * [Login - Repository and Service layers](mvc/login) * [Hello world](mvc/hello-world/main.go) * [Basic](mvc/basic/main.go) * [Wildcard](mvc/basic/wildcard/main.go) @@ -179,27 +189,13 @@ * [Authenticated Controller](mvc/authenticated-controller/main.go) * [Websocket Controller](mvc/websocket) * [Register Middleware](mvc/middleware) -* Object-Relational Mapping - * [Using `go-xorm/xorm` (Mysql, MyMysql, Postgres, Tidb, SQLite, MsSql, MsSql, Oracle)](orm/xorm/main.go) - * [Using `jinzhu/gorm`](orm/gorm/main.go) -* Project Structure - * [Bootstrapper](structuring/bootstrap) - * [MVC with Repository and Service layer Overview](structuring/mvc-plus-repository-and-service-layers) - * [Login (MVC with Single Responsibility package)](structuring/login-mvc-single-responsibility-package) - * [Login (MVC with Datamodels, Datasource, Repository and Service layer)](structuring/login-mvc) + * [gRPC](mvc/grpc-compatible) + * [Login (Repository and Service layers)](mvc/login) + * [Login (Single Responsibility)](mvc/login-mvc-single-responsibility) + * [Vue.js Todo App](mvc/vuejs-todo-mvc) +* [Bootstrapper](bootstrap) * Desktop Applications - * [The blink package](desktop-app/blink) - * [The lorca package](desktop-app/lorca) - * [The webview package](desktop-app/webview) -* Middlewares (Builtin) - * [JWT](miscellaneous/jwt/main.go) - * [Rate Limit](miscellaneous/ratelimit/main.go) - * [HTTP Method Override](https://github.com/kataras/iris/blob/master/middleware/methodoverride/methodoverride_test.go) - * [Request Logger](http_request/request-logger/main.go) - * [Log Requests to a File](http_request/request-logger/request-logger-file/main.go) - * [Recovery](miscellaneous/recover/main.go) - * [Profiling (pprof)](miscellaneous/pprof/main.go) - * [Internal Application File Logger](miscellaneous/file-logger/main.go) - * [Google reCAPTCHA](miscellaneous/recaptcha/main.go) - * [hCaptcha](miscellaneous/hcaptcha/main.go) + * [The blink package](desktop/blink) + * [The lorca package](desktop/lorca) + * [The webview package](desktop/webview) * Middlewares [(Community)](https://github.com/iris-contrib/middleware) diff --git a/_examples/apidoc/swagger/README.md b/_examples/apidoc/swagger/README.md new file mode 100644 index 00000000..08e23049 --- /dev/null +++ b/_examples/apidoc/swagger/README.md @@ -0,0 +1,3 @@ +# Swagger 2.0 + +Visit https://github.com/iris-contrib/swagger instead. diff --git a/_examples/authentication/basicauth/main.go b/_examples/auth/basicauth/main.go similarity index 100% rename from _examples/authentication/basicauth/main.go rename to _examples/auth/basicauth/main.go diff --git a/_examples/authentication/basicauth/main_test.go b/_examples/auth/basicauth/main_test.go similarity index 100% rename from _examples/authentication/basicauth/main_test.go rename to _examples/auth/basicauth/main_test.go diff --git a/_examples/authentication/oauth2/main.go b/_examples/auth/goth/main.go similarity index 100% rename from _examples/authentication/oauth2/main.go rename to _examples/auth/goth/main.go diff --git a/_examples/authentication/oauth2/templates/index.html b/_examples/auth/goth/templates/index.html similarity index 93% rename from _examples/authentication/oauth2/templates/index.html rename to _examples/auth/goth/templates/index.html index 202c9e91..53652804 100644 --- a/_examples/authentication/oauth2/templates/index.html +++ b/_examples/auth/goth/templates/index.html @@ -1,3 +1,3 @@ -{{range $key,$value:=.Providers}} -

Log in with {{index $.ProvidersMap $value}}

+{{range $key,$value:=.Providers}} +

Log in with {{index $.ProvidersMap $value}}

{{end}} \ No newline at end of file diff --git a/_examples/authentication/oauth2/templates/user.html b/_examples/auth/goth/templates/user.html similarity index 88% rename from _examples/authentication/oauth2/templates/user.html rename to _examples/auth/goth/templates/user.html index 40544f64..10ab7c5c 100644 --- a/_examples/authentication/oauth2/templates/user.html +++ b/_examples/auth/goth/templates/user.html @@ -1,11 +1,11 @@ -

logout

-

Name: {{.Name}} [{{.LastName}}, {{.FirstName}}]

-

Email: {{.Email}}

-

NickName: {{.NickName}}

-

Location: {{.Location}}

-

AvatarURL: {{.AvatarURL}}

-

Description: {{.Description}}

-

UserID: {{.UserID}}

-

AccessToken: {{.AccessToken}}

-

ExpiresAt: {{.ExpiresAt}}

+

logout

+

Name: {{.Name}} [{{.LastName}}, {{.FirstName}}]

+

Email: {{.Email}}

+

NickName: {{.NickName}}

+

Location: {{.Location}}

+

AvatarURL: {{.AvatarURL}}

+

Description: {{.Description}}

+

UserID: {{.UserID}}

+

AccessToken: {{.AccessToken}}

+

ExpiresAt: {{.ExpiresAt}}

RefreshToken: {{.RefreshToken}}

\ No newline at end of file diff --git a/_examples/miscellaneous/hcaptcha/hosts b/_examples/auth/hcaptcha/hosts similarity index 100% rename from _examples/miscellaneous/hcaptcha/hosts rename to _examples/auth/hcaptcha/hosts diff --git a/_examples/miscellaneous/hcaptcha/main.go b/_examples/auth/hcaptcha/main.go similarity index 100% rename from _examples/miscellaneous/hcaptcha/main.go rename to _examples/auth/hcaptcha/main.go diff --git a/_examples/miscellaneous/hcaptcha/templates/register_form.html b/_examples/auth/hcaptcha/templates/register_form.html similarity index 100% rename from _examples/miscellaneous/hcaptcha/templates/register_form.html rename to _examples/auth/hcaptcha/templates/register_form.html diff --git a/_examples/miscellaneous/jwt/README.md b/_examples/auth/jwt/README.md similarity index 100% rename from _examples/miscellaneous/jwt/README.md rename to _examples/auth/jwt/README.md diff --git a/_examples/miscellaneous/jwt/main.go b/_examples/auth/jwt/main.go similarity index 95% rename from _examples/miscellaneous/jwt/main.go rename to _examples/auth/jwt/main.go index 8e4d6c9a..77f9648f 100644 --- a/_examples/miscellaneous/jwt/main.go +++ b/_examples/auth/jwt/main.go @@ -19,7 +19,7 @@ func main() { // or defaults to "secret" and "itsa16bytesecret" respectfully. // // Use the `jwt.New` instead for more flexibility, if necessary. - j := jwt.DefaultHMAC(15*time.Minute, "secret", "itsa16bytesecret") + j := jwt.HMAC(15*time.Minute, "secret", "itsa16bytesecret") app := iris.New() app.Logger().SetLevel("debug") @@ -68,7 +68,7 @@ func main() { /* func default_RSA_Example() { - j := jwt.DefaultRSA(1 * time.Minute) + j := jwt.RSA(15*time.Minute) } Same as: @@ -115,7 +115,7 @@ func hmac_Example() { /* func load_From_File_With_Password_Example() { - b, err := ioutil.ReadFile("./private_rsa.pem") + b, err := ioutil.ReadFile("./rsa_password_protected.key") if err != nil { panic(err) } diff --git a/_examples/miscellaneous/jwt/rsa_password_protected.key b/_examples/auth/jwt/rsa_password_protected.key similarity index 100% rename from _examples/miscellaneous/jwt/rsa_password_protected.key rename to _examples/auth/jwt/rsa_password_protected.key diff --git a/_examples/permissions/main.go b/_examples/auth/permissions/main.go similarity index 100% rename from _examples/permissions/main.go rename to _examples/auth/permissions/main.go diff --git a/_examples/miscellaneous/recaptcha/custom_form/main.go b/_examples/auth/recaptcha/custom_form/main.go similarity index 100% rename from _examples/miscellaneous/recaptcha/custom_form/main.go rename to _examples/auth/recaptcha/custom_form/main.go diff --git a/_examples/miscellaneous/recaptcha/main.go b/_examples/auth/recaptcha/main.go similarity index 100% rename from _examples/miscellaneous/recaptcha/main.go rename to _examples/auth/recaptcha/main.go diff --git a/_examples/authentication/README.md b/_examples/authentication/README.md deleted file mode 100644 index 47939fef..00000000 --- a/_examples/authentication/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Authentication - -- [Basic Authentication](basicauth/main.go) -- [OAUth2](oauth2/main.go) -- [JWT](https://github.com/kataras/iris/tree/master/_examples/miscellaneous/jwt) -- [JWT (community edition)](https://github.com/iris-contrib/middleware/blob/master/jwt) -- [Sessions](https://github.com/kataras/iris/tree/master/_examples/sessions) diff --git a/_examples/structuring/bootstrap/bootstrap/bootstrapper.go b/_examples/bootstrap/bootstrap/bootstrapper.go similarity index 100% rename from _examples/structuring/bootstrap/bootstrap/bootstrapper.go rename to _examples/bootstrap/bootstrap/bootstrapper.go diff --git a/_examples/structuring/bootstrap/folder_structure.png b/_examples/bootstrap/folder_structure.png similarity index 100% rename from _examples/structuring/bootstrap/folder_structure.png rename to _examples/bootstrap/folder_structure.png diff --git a/_examples/structuring/bootstrap/main.go b/_examples/bootstrap/main.go similarity index 54% rename from _examples/structuring/bootstrap/main.go rename to _examples/bootstrap/main.go index f5732b59..24054145 100644 --- a/_examples/structuring/bootstrap/main.go +++ b/_examples/bootstrap/main.go @@ -1,9 +1,9 @@ package main import ( - "github.com/kataras/iris/v12/_examples/structuring/bootstrap/bootstrap" - "github.com/kataras/iris/v12/_examples/structuring/bootstrap/middleware/identity" - "github.com/kataras/iris/v12/_examples/structuring/bootstrap/routes" + "github.com/kataras/iris/v12/_examples/bootstrap/bootstrap" + "github.com/kataras/iris/v12/_examples/bootstrap/middleware/identity" + "github.com/kataras/iris/v12/_examples/bootstrap/routes" ) func newApp() *bootstrap.Bootstrapper { diff --git a/_examples/structuring/bootstrap/main_test.go b/_examples/bootstrap/main_test.go similarity index 81% rename from _examples/structuring/bootstrap/main_test.go rename to _examples/bootstrap/main_test.go index ecfee26d..959c04eb 100644 --- a/_examples/structuring/bootstrap/main_test.go +++ b/_examples/bootstrap/main_test.go @@ -14,11 +14,11 @@ func TestApp(t *testing.T) { // test our routes e.GET("/").Expect().Status(httptest.StatusOK) e.GET("/follower/42").Expect().Status(httptest.StatusOK). - Body().Equal("from /follower/{id:long} with ID: 42") + Body().Equal("from /follower/{id:int64} with ID: 42") e.GET("/following/52").Expect().Status(httptest.StatusOK). - Body().Equal("from /following/{id:long} with ID: 52") + Body().Equal("from /following/{id:int64} with ID: 52") e.GET("/like/64").Expect().Status(httptest.StatusOK). - Body().Equal("from /like/{id:long} with ID: 64") + Body().Equal("from /like/{id:int64} with ID: 64") // test not found e.GET("/notfound").Expect().Status(httptest.StatusNotFound) diff --git a/_examples/structuring/bootstrap/middleware/identity/identity.go b/_examples/bootstrap/middleware/identity/identity.go similarity index 91% rename from _examples/structuring/bootstrap/middleware/identity/identity.go rename to _examples/bootstrap/middleware/identity/identity.go index feb6ebce..2228fbac 100644 --- a/_examples/structuring/bootstrap/middleware/identity/identity.go +++ b/_examples/bootstrap/middleware/identity/identity.go @@ -5,7 +5,7 @@ import ( "github.com/kataras/iris/v12" - "github.com/kataras/iris/v12/_examples/structuring/bootstrap/bootstrap" + "github.com/kataras/iris/v12/_examples/bootstrap/bootstrap" ) // New returns a new handler which adds some headers and view data diff --git a/_examples/structuring/bootstrap/public/favicon.ico b/_examples/bootstrap/public/favicon.ico similarity index 100% rename from _examples/structuring/bootstrap/public/favicon.ico rename to _examples/bootstrap/public/favicon.ico diff --git a/_examples/structuring/bootstrap/routes/follower.go b/_examples/bootstrap/routes/follower.go similarity index 100% rename from _examples/structuring/bootstrap/routes/follower.go rename to _examples/bootstrap/routes/follower.go diff --git a/_examples/structuring/bootstrap/routes/following.go b/_examples/bootstrap/routes/following.go similarity index 100% rename from _examples/structuring/bootstrap/routes/following.go rename to _examples/bootstrap/routes/following.go diff --git a/_examples/structuring/bootstrap/routes/index.go b/_examples/bootstrap/routes/index.go similarity index 100% rename from _examples/structuring/bootstrap/routes/index.go rename to _examples/bootstrap/routes/index.go diff --git a/_examples/structuring/bootstrap/routes/like.go b/_examples/bootstrap/routes/like.go similarity index 100% rename from _examples/structuring/bootstrap/routes/like.go rename to _examples/bootstrap/routes/like.go diff --git a/_examples/bootstrap/routes/routes.go b/_examples/bootstrap/routes/routes.go new file mode 100644 index 00000000..c7b19042 --- /dev/null +++ b/_examples/bootstrap/routes/routes.go @@ -0,0 +1,13 @@ +package routes + +import ( + "github.com/kataras/iris/v12/_examples/bootstrap/bootstrap" +) + +// Configure registers the necessary routes to the app. +func Configure(b *bootstrap.Bootstrapper) { + b.Get("/", GetIndexHandler) + b.Get("/follower/{id:int64}", GetFollowerHandler) + b.Get("/following/{id:int64}", GetFollowingHandler) + b.Get("/like/{id:int64}", GetLikeHandler) +} diff --git a/_examples/structuring/bootstrap/views/index.html b/_examples/bootstrap/views/index.html similarity index 100% rename from _examples/structuring/bootstrap/views/index.html rename to _examples/bootstrap/views/index.html diff --git a/_examples/structuring/bootstrap/views/shared/error.html b/_examples/bootstrap/views/shared/error.html similarity index 83% rename from _examples/structuring/bootstrap/views/shared/error.html rename to _examples/bootstrap/views/shared/error.html index 09787a2f..9fde08ad 100644 --- a/_examples/structuring/bootstrap/views/shared/error.html +++ b/_examples/bootstrap/views/shared/error.html @@ -1,5 +1,5 @@ -

Error.

-

An error occurred while processing your request.

- -

{{.Err.status}}

+

Error.

+

An error occurred while processing your request.

+ +

{{.Err.status}}

{{.Err.message}}

\ No newline at end of file diff --git a/_examples/structuring/bootstrap/views/shared/layout.html b/_examples/bootstrap/views/shared/layout.html similarity index 94% rename from _examples/structuring/bootstrap/views/shared/layout.html rename to _examples/bootstrap/views/shared/layout.html index 70dbf7dd..cf920444 100644 --- a/_examples/structuring/bootstrap/views/shared/layout.html +++ b/_examples/bootstrap/views/shared/layout.html @@ -1,23 +1,23 @@ - - - - - - - - {{.Title}} - {{.AppName}} - - - - -
- - {{ yield }} -
-
-

© 2017 - {{.AppOwner}}

-
-
- - + + + + + + + + {{.Title}} - {{.AppName}} + + + + +
+ + {{ yield }} +
+
+

© 2017 - {{.AppOwner}}

+
+
+ + \ No newline at end of file diff --git a/_examples/tutorial/caddy/Caddyfile b/_examples/caddy/Caddyfile similarity index 95% rename from _examples/tutorial/caddy/Caddyfile rename to _examples/caddy/Caddyfile index cb0f207a..ecbee979 100644 --- a/_examples/tutorial/caddy/Caddyfile +++ b/_examples/caddy/Caddyfile @@ -1,9 +1,9 @@ -example.com { - header / Server "Iris" - proxy / example.com:9091 # localhost:9091 -} - -api.example.com { - header / Server "Iris" - proxy / api.example.com:9092 # localhost:9092 +example.com { + header / Server "Iris" + proxy / example.com:9091 # localhost:9091 +} + +api.example.com { + header / Server "Iris" + proxy / api.example.com:9092 # localhost:9092 } \ No newline at end of file diff --git a/_examples/tutorial/caddy/README.md b/_examples/caddy/README.md similarity index 77% rename from _examples/tutorial/caddy/README.md rename to _examples/caddy/README.md index 6be873d0..e8c601c3 100644 --- a/_examples/tutorial/caddy/README.md +++ b/_examples/caddy/README.md @@ -1,24 +1,24 @@ -# Caddy loves Iris - -The `Caddyfile` shows how you can use caddy to listen on ports 80 & 443 and sit in front of iris webserver(s) that serving on a different port (9091 and 9092 in this case; see Caddyfile). - -## Running our two web servers - -1. Go to `$GOPATH/src/github.com/kataras/iris/_examples/tutorial/caddy/server1` -2. Open a terminal window and execute `go run main.go` -3. Go to `$GOPATH/src/github.com/kataras/iris/_examples/tutorial/caddy/server2` -4. Open a new terminal window and execute `go run main.go` - -## Caddy installation - -1. Download caddy: https://caddyserver.com/download -2. Extract its contents where the `Caddyfile` is located, the `$GOPATH/src/github.com/kataras/iris/_examples/tutorial/caddy` in this case -3. Open, read and modify the `Caddyfile` to see by yourself how easy it is to configure the servers -4. Run `caddy` directly or open a terminal window and execute `caddy` -5. Go to `https://example.com` and `https://api.example.com/user/42` - - -## Notes - -Iris has the `app.Run(iris.AutoTLS(":443", "example.com", "mail@example.com"))` which does +# Caddy loves Iris + +The `Caddyfile` shows how you can use caddy to listen on ports 80 & 443 and sit in front of iris webserver(s) that serving on a different port (9091 and 9092 in this case; see Caddyfile). + +## Running our two web servers + +1. Go to `$GOPATH/src/github.com/kataras/iris/_examples/caddy/server1` +2. Open a terminal window and execute `go run main.go` +3. Go to `$GOPATH/src/github.com/kataras/iris/_examples/caddy/server2` +4. Open a new terminal window and execute `go run main.go` + +## Caddy installation + +1. Download caddy: https://caddyserver.com/download +2. Extract its contents where the `Caddyfile` is located, the `$GOPATH/src/github.com/kataras/iris/_examples/caddy` in this case +3. Open, read and modify the `Caddyfile` to see by yourself how easy it is to configure the servers +4. Run `caddy` directly or open a terminal window and execute `caddy` +5. Go to `https://example.com` and `https://api.example.com/user/42` + + +## Notes + +Iris has the `app.Run(iris.AutoTLS(":443", "example.com", "mail@example.com"))` which does the exactly same thing but caddy is a great tool that helps you when you run multiple web servers from one host machine, i.e iris, apache, tomcat. \ No newline at end of file diff --git a/_examples/tutorial/caddy/server1/main.go b/_examples/caddy/server1/main.go similarity index 100% rename from _examples/tutorial/caddy/server1/main.go rename to _examples/caddy/server1/main.go diff --git a/_examples/tutorial/caddy/server1/views/index.html b/_examples/caddy/server1/views/index.html similarity index 74% rename from _examples/tutorial/caddy/server1/views/index.html rename to _examples/caddy/server1/views/index.html index 88a21488..3d4a81f6 100644 --- a/_examples/tutorial/caddy/server1/views/index.html +++ b/_examples/caddy/server1/views/index.html @@ -1,3 +1,3 @@ -
- {{.Message}} +
+ {{.Message}}
\ No newline at end of file diff --git a/_examples/tutorial/caddy/server1/views/shared/layout.html b/_examples/caddy/server1/views/shared/layout.html similarity index 84% rename from _examples/tutorial/caddy/server1/views/shared/layout.html rename to _examples/caddy/server1/views/shared/layout.html index b2f504a9..141a75f7 100644 --- a/_examples/tutorial/caddy/server1/views/shared/layout.html +++ b/_examples/caddy/server1/views/shared/layout.html @@ -1,11 +1,11 @@ - - - - {{.Layout.Title}} - - - - {{ yield }} - - + + + + {{.Layout.Title}} + + + + {{ yield }} + + \ No newline at end of file diff --git a/_examples/tutorial/caddy/server2/main.go b/_examples/caddy/server2/main.go similarity index 96% rename from _examples/tutorial/caddy/server2/main.go rename to _examples/caddy/server2/main.go index 282aa1c3..45a9ed80 100644 --- a/_examples/tutorial/caddy/server2/main.go +++ b/_examples/caddy/server2/main.go @@ -35,7 +35,7 @@ func (c *UserController) Get() string { // User is our test User model, nothing tremendous here. type User struct{ ID int64 } -// GetBy handles GET /user/42, equal to .Get("/user/{id:long}") +// GetBy handles GET /user/42, equal to .Get("/user/{id:int64}") func (c *UserController) GetBy(id int64) User { // Select User by ID == $id. return User{id} diff --git a/_examples/tutorial/mongodb/.env b/_examples/database/mongodb/.env similarity index 100% rename from _examples/tutorial/mongodb/.env rename to _examples/database/mongodb/.env diff --git a/_examples/tutorial/mongodb/0_create_movie.png b/_examples/database/mongodb/0_create_movie.png similarity index 100% rename from _examples/tutorial/mongodb/0_create_movie.png rename to _examples/database/mongodb/0_create_movie.png diff --git a/_examples/tutorial/mongodb/1_update_movie.png b/_examples/database/mongodb/1_update_movie.png similarity index 100% rename from _examples/tutorial/mongodb/1_update_movie.png rename to _examples/database/mongodb/1_update_movie.png diff --git a/_examples/tutorial/mongodb/2_get_all_movies.png b/_examples/database/mongodb/2_get_all_movies.png similarity index 100% rename from _examples/tutorial/mongodb/2_get_all_movies.png rename to _examples/database/mongodb/2_get_all_movies.png diff --git a/_examples/tutorial/mongodb/3_get_movie.png b/_examples/database/mongodb/3_get_movie.png similarity index 100% rename from _examples/tutorial/mongodb/3_get_movie.png rename to _examples/database/mongodb/3_get_movie.png diff --git a/_examples/tutorial/mongodb/4_delete_movie.png b/_examples/database/mongodb/4_delete_movie.png similarity index 100% rename from _examples/tutorial/mongodb/4_delete_movie.png rename to _examples/database/mongodb/4_delete_movie.png diff --git a/_examples/database/mongodb/Dockerfile b/_examples/database/mongodb/Dockerfile new file mode 100644 index 00000000..dec864fe --- /dev/null +++ b/_examples/database/mongodb/Dockerfile @@ -0,0 +1,17 @@ +# docker build -t myapp . +# docker run --rm -it -p 8080:8080 myapp:latest +FROM golang:latest AS builder +RUN apt-get update +ENV GO111MODULE=on \ + CGO_ENABLED=0 \ + GOOS=linux \ + GOARCH=amd64 +WORKDIR /go/src/app +COPY go.mod . +RUN go mod download +COPY . . +RUN go install + +FROM scratch +COPY --from=builder /go/bin/myapp . +ENTRYPOINT ["./myapp"] \ No newline at end of file diff --git a/_examples/tutorial/mongodb/README.md b/_examples/database/mongodb/README.md similarity index 86% rename from _examples/tutorial/mongodb/README.md rename to _examples/database/mongodb/README.md index 967eb118..4953dd17 100644 --- a/_examples/tutorial/mongodb/README.md +++ b/_examples/database/mongodb/README.md @@ -7,11 +7,17 @@ Article is coming soon, follow and stay tuned Read [the fully functional example](main.go). +## Run + +### Docker + +Install [Docker](https://www.docker.com/) and execute the command below + ```sh -$ go get -u go.mongodb.org/mongo-driver/... -$ go get -u github.com/joho/godotenv +$ docker-compose up ``` +### Manually ```sh # .env file contents @@ -22,7 +28,7 @@ DSN=mongodb://localhost:27017 ```sh $ go run main.go > 2019/01/28 05:17:59 Loading environment variables from file: .env -> 2019/01/28 05:17:59 ◽ PORT=8080 +> 2019/01/28 05:17:59 ◽ Port=8080 > 2019/01/28 05:17:59 ◽ DSN=mongodb://localhost:27017 > Now listening on: http://localhost:8080 ``` diff --git a/_examples/tutorial/mongodb/api/store/movie.go b/_examples/database/mongodb/api/store/movie.go similarity index 94% rename from _examples/tutorial/mongodb/api/store/movie.go rename to _examples/database/mongodb/api/store/movie.go index cbc281aa..3a2d9fb2 100644 --- a/_examples/tutorial/mongodb/api/store/movie.go +++ b/_examples/database/mongodb/api/store/movie.go @@ -1,8 +1,8 @@ package storeapi import ( - "github.com/kataras/iris/v12/_examples/tutorial/mongodb/httputil" - "github.com/kataras/iris/v12/_examples/tutorial/mongodb/store" + "myapp/httputil" + "myapp/store" "github.com/kataras/iris/v12" ) diff --git a/_examples/database/mongodb/docker-compose.yml b/_examples/database/mongodb/docker-compose.yml new file mode 100644 index 00000000..a9eec93e --- /dev/null +++ b/_examples/database/mongodb/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3.1" + +services: + app: + build: . + environment: + Port: 8080 + DSN: db:27017 + ports: + - 8080:8080 + depends_on: + - db + db: + image: mongo + environment: + MONGO_INITDB_DATABASE: store + ports: + - 27017:27017 diff --git a/_examples/tutorial/mongodb/env/env.go b/_examples/database/mongodb/env/env.go similarity index 64% rename from _examples/tutorial/mongodb/env/env.go rename to _examples/database/mongodb/env/env.go index 24ead415..9f735b43 100644 --- a/_examples/tutorial/mongodb/env/env.go +++ b/_examples/database/mongodb/env/env.go @@ -22,6 +22,9 @@ var ( func parse() { Port = getDefault("PORT", "8080") DSN = getDefault("DSN", "mongodb://localhost:27017") + + log.Printf("• Port=%s\n", Port) + log.Printf("• DSN=%s\n", DSN) } // Load loads environment variables that are being used across the whole app. @@ -34,28 +37,31 @@ func parse() { // After `Load` the callers can get an environment variable via `os.Getenv`. func Load(envFileName string) { if args := os.Args; len(args) > 1 && args[1] == "help" { - fmt.Fprintln(os.Stderr, "https://github.com/kataras/iris/blob/master/_examples/tutorials/mongodb/README.md") + fmt.Fprintln(os.Stderr, "https://github.com/kataras/iris/blob/master/_examples/database/mongodb/README.md") os.Exit(-1) } - log.Printf("Loading environment variables from file: %s\n", envFileName) // If more than one filename passed with comma separated then load from all // of these, a env file can be a partial too. envFiles := strings.Split(envFileName, ",") - for i := range envFiles { - if filepath.Ext(envFiles[i]) == "" { - envFiles[i] += ".env" + for _, envFile := range envFiles { + if filepath.Ext(envFile) == "" { + envFile += ".env" + } + + if fileExists(envFile) { + log.Printf("Loading environment variables from file: %s\n", envFile) + + if err := godotenv.Load(envFile); err != nil { + panic(fmt.Sprintf("error loading environment variables from [%s]: %v", envFile, err)) + } } } - if err := godotenv.Load(envFiles...); err != nil { - panic(fmt.Sprintf("error loading environment variables from [%s]: %v", envFileName, err)) - } - - envMap, _ := godotenv.Read(envFiles...) - for k, v := range envMap { - log.Printf("◽ %s=%s\n", k, v) - } + // envMap, _ := godotenv.Read(envFiles...) + // for k, v := range envMap { + // log.Printf("◽ %s=%s\n", k, v) + // } parse() } @@ -69,3 +75,11 @@ func getDefault(key string, def string) string { return value } + +func fileExists(filename string) bool { + info, err := os.Stat(filename) + if os.IsNotExist(err) { + return false + } + return !info.IsDir() +} diff --git a/_examples/database/mongodb/go.mod b/_examples/database/mongodb/go.mod new file mode 100644 index 00000000..c723b6bc --- /dev/null +++ b/_examples/database/mongodb/go.mod @@ -0,0 +1,9 @@ +module myapp + +go 1.14 + +require ( + github.com/joho/godotenv v1.3.0 + github.com/kataras/iris/v12 v12.2.0 + go.mongodb.org/mongo-driver v1.3.4 +) diff --git a/_examples/tutorial/mongodb/httputil/error.go b/_examples/database/mongodb/httputil/error.go similarity index 100% rename from _examples/tutorial/mongodb/httputil/error.go rename to _examples/database/mongodb/httputil/error.go diff --git a/_examples/tutorial/mongodb/main.go b/_examples/database/mongodb/main.go similarity index 88% rename from _examples/tutorial/mongodb/main.go rename to _examples/database/mongodb/main.go index ca8ebdb9..185d08f6 100644 --- a/_examples/tutorial/mongodb/main.go +++ b/_examples/database/mongodb/main.go @@ -11,11 +11,11 @@ import ( "os" // APIs - storeapi "github.com/kataras/iris/v12/_examples/tutorial/mongodb/api/store" + storeapi "myapp/api/store" // - "github.com/kataras/iris/v12/_examples/tutorial/mongodb/env" - "github.com/kataras/iris/v12/_examples/tutorial/mongodb/store" + "myapp/env" + "myapp/store" "github.com/kataras/iris/v12" @@ -30,7 +30,7 @@ func init() { flagset := flag.CommandLine flagset.StringVar(&envFileName, "env", envFileName, "the env file which web app will use to extract its environment variables") - flag.CommandLine.Parse(os.Args[1:]) + flagset.Parse(os.Args[1:]) env.Load(envFileName) } diff --git a/_examples/tutorial/mongodb/store/movie.go b/_examples/database/mongodb/store/movie.go similarity index 100% rename from _examples/tutorial/mongodb/store/movie.go rename to _examples/database/mongodb/store/movie.go diff --git a/_examples/database/mysql/Dockerfile b/_examples/database/mysql/Dockerfile new file mode 100644 index 00000000..dec864fe --- /dev/null +++ b/_examples/database/mysql/Dockerfile @@ -0,0 +1,17 @@ +# docker build -t myapp . +# docker run --rm -it -p 8080:8080 myapp:latest +FROM golang:latest AS builder +RUN apt-get update +ENV GO111MODULE=on \ + CGO_ENABLED=0 \ + GOOS=linux \ + GOARCH=amd64 +WORKDIR /go/src/app +COPY go.mod . +RUN go mod download +COPY . . +RUN go install + +FROM scratch +COPY --from=builder /go/bin/myapp . +ENTRYPOINT ["./myapp"] \ No newline at end of file diff --git a/_examples/database/mysql/README.md b/_examples/database/mysql/README.md new file mode 100644 index 00000000..25755226 --- /dev/null +++ b/_examples/database/mysql/README.md @@ -0,0 +1,146 @@ +# Iris, MySQL, Groupcache & Docker Example + +## 📘 Endpoints + +| Method | Path | Description | URL Parameters | Body | Auth Required | +|--------|---------------------|------------------------|--------------- |----------------------------|---------------| +| ANY | /token | Prints a new JWT Token | - | - | - | +| GET | /category | Lists a set of Categories | offset, limit, order | - | - | +| POST | /category | Creates a Category | - | JSON [Full Category](migration/api_category/create_category.json) | Token | +| PUT | /category | Fully-Updates a Category | - | JSON [Full Category](migration/api_category/update_category.json) | Token | +| PATCH | /category/{id} | Partially-Updates a Category | - | JSON [Partial Category](migration/api_category/update_partial_category.json) | Token | +| GET | /category/{id} | Prints a Category | - | - | - | +| DELETE | /category/{id} | Deletes a Category | - | - | Token | +| GET | /category/{id}/products | Lists all Products from a Category | offset, limit, order | - | - | +| POST | /category/{id}/products | (Batch) Assigns one or more Products to a Category | - | JSON [Products](migration/api_category/insert_products_category.json) | Token | +| GET | /product | Lists a set of Products (cache) | offset, limit, order | - | - | +| POST | /product | Creates a Product | - | JSON [Full Product](migration/api_product/create_product.json) | Token | +| PUT | /product | Fully-Updates a Product | - | JSON [Full Product](migration/api_product/update_product.json) | Token | +| PATCH | /product/{id} | Partially-Updates a Product | - | JSON [Partial Product](migration/api_product/update_partial_product.json) | Token | +| GET | /product/{id} | Prints a Product (cache) | - | - | - | +| DELETE | /product/{id} | Deletes a Product | - | - | Token | + + + +## 📑 Responses + +* **Content-Type** of `"application/json;charset=utf-8"`, snake_case naming (identical to the database columns) +* **Status Codes** + * 500 for server(db) errors, + * 422 for validation errors, e.g. + ```json + { + "code": 422, + "message": "required fields are missing", + "timestamp": 1589306271 + } + ``` + * 400 for malformed syntax, e.g. + ```json + { + "code": 400, + "message": "json: cannot unmarshal number -2 into Go struct field Category.position of type uint64", + "timestamp": 1589306325 + } + ``` + ```json + { + "code": 400, + "message": "json: unknown field \"field_not_exists\"", + "timestamp": 1589306367 + } + ``` + * 404 for entity not found, e.g. + ```json + { + "code": 404, + "message": "entity does not exist", + "timestamp": 1589306199 + } + ``` + * 304 for unaffected UPDATE or DELETE, + * 201 for CREATE with the last inserted ID, + * 200 for GET, UPDATE and DELETE + +## ⚡ Get Started + +Download the folder. + +### Install (Docker) + +Install [Docker](https://www.docker.com/) and execute the command below + +```sh +$ docker-compose up +``` + +### Install (Manually) + +Run `go build` or `go run main.go` and read below. + +#### MySQL + +Environment variables: + +```sh +MYSQL_USER=user_myapp +MYSQL_PASSWORD=dbpassword +MYSQL_HOST=localhost +MYSQL_DATABASE=myapp +``` + +Download the schema from [migration/myapp.sql](migration/myapp.sql) and execute it against your MySQL server instance. + +```sql +CREATE DATABASE IF NOT EXISTS myapp DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; + +USE myapp; + +SET NAMES utf8mb4; +SET FOREIGN_KEY_CHECKS = 0; + +DROP TABLE IF EXISTS categories; +CREATE TABLE categories ( + id int(11) NOT NULL AUTO_INCREMENT, + title varchar(255) NOT NULL, + position int(11) NOT NULL, + image_url varchar(255) NOT NULL, + created_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, + updated_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + PRIMARY KEY (id) +); + +DROP TABLE IF EXISTS products; +CREATE TABLE products ( + id int(11) NOT NULL AUTO_INCREMENT, + category_id int, + title varchar(255) NOT NULL, + image_url varchar(255) NOT NULL, + price decimal(10,2) NOT NULL, + description text NOT NULL, + created_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, + updated_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + PRIMARY KEY (id), + FOREIGN KEY (category_id) REFERENCES categories(id) +); + +SET FOREIGN_KEY_CHECKS = 1; +``` + +### Requests + +Some request bodies can be found at: [migration/api_category](migration/api_category) and [migration/api_product](migration/api_product). **However** I've provided a [postman.json](migration/myapp_postman.json) Collection that you can import to your [POSTMAN](https://learning.postman.com/docs/postman/collections/importing-and-exporting-data/#collections) and start playing with the API. + +All write-access endpoints are "protected" via JWT, a client should "verify" itself. You'll need to manually take the **token** from the `http://localhost:8080/token` and put it on url parameter `?token=$token` or to the `Authentication: Bearer $token` request header. + +### Unit or End-To-End Testing? + +Testing is important. The code is written in a way that testing should be trivial (Pseudo/memory Database or SQLite local file could be integrated as well, for end-to-end tests a Docker image with MySQL and fire tests against that server). However, there is [nothing(?)](service/category_service_test.go) to see here. + +## Packages + +- https://github.com/dgrijalva/jwt-go (JWT parsing) +- https://github.com/go-sql-driver/mysql (Go Driver for MySQL) +- https://github.com/DATA-DOG/go-sqlmock (Testing DB see [service/category_service_test.go](service/category_service_test.go)) +- https://github.com/kataras/iris (HTTP) +- https://github.com/mailgun/groupcache (Caching) diff --git a/_examples/database/mysql/api/api.go b/_examples/database/mysql/api/api.go new file mode 100644 index 00000000..2691fdf4 --- /dev/null +++ b/_examples/database/mysql/api/api.go @@ -0,0 +1,97 @@ +// Package api contains the handlers for our HTTP Endpoints. +package api + +import ( + "time" + + "myapp/service" + "myapp/sql" + + "github.com/kataras/iris/v12" + "github.com/kataras/iris/v12/middleware/jwt" + "github.com/kataras/iris/v12/middleware/requestid" +) + +// Router accepts any required dependencies and returns the main server's handler. +func Router(db sql.Database, secret string) func(iris.Party) { + return func(r iris.Party) { + j := jwt.HMAC(15*time.Minute, secret) + + r.Use(requestid.New()) + r.Use(verifyToken(j)) + // Generate a token for testing by navigating to + // http://localhost:8080/token endpoint. + // Copy-paste it to a ?token=$token url parameter or + // open postman and put an Authentication: Bearer $token to get + // access on create, update and delete endpoinds. + + r.Get("/token", writeToken(j)) + + var ( + categoryService = service.NewCategoryService(db) + productService = service.NewProductService(db) + ) + + cat := r.Party("/category") + { + // TODO: new Use to add middlewares to specific + // routes per METHOD ( we already have the per path through parties.) + handler := NewCategoryHandler(categoryService) + + cat.Get("/", handler.List) + cat.Post("/", handler.Create) + cat.Put("/", handler.Update) + + cat.Get("/{id:int64}", handler.GetByID) + cat.Patch("/{id:int64}", handler.PartialUpdate) + cat.Delete("/{id:int64}", handler.Delete) + /* You can also do something like that: + cat.PartyFunc("/{id:int64}", func(c iris.Party) { + c.Get("/", handler.GetByID) + c.Post("/", handler.PartialUpdate) + c.Delete("/", handler.Delete) + }) + */ + + cat.Get("/{id:int64}/products", handler.ListProducts) + cat.Post("/{id:int64}/products", handler.InsertProducts(productService)) + } + + prod := r.Party("/product") + { + handler := NewProductHandler(productService) + + prod.Get("/", handler.List) + prod.Post("/", handler.Create) + prod.Put("/", handler.Update) + + prod.Get("/{id:int64}", handler.GetByID) + prod.Patch("/{id:int64}", handler.PartialUpdate) + prod.Delete("/{id:int64}", handler.Delete) + } + + } +} + +func writeToken(j *jwt.JWT) iris.Handler { + return func(ctx iris.Context) { + claims := jwt.Claims{ + Issuer: "https://iris-go.com", + Audience: jwt.Audience{requestid.Get(ctx)}, + } + + j.WriteToken(ctx, claims) + } +} + +func verifyToken(j *jwt.JWT) iris.Handler { + return func(ctx iris.Context) { + // Allow all GET. + if ctx.Method() == iris.MethodGet { + ctx.Next() + return + } + + j.Verify(ctx) + } +} diff --git a/_examples/database/mysql/api/category_handler.go b/_examples/database/mysql/api/category_handler.go new file mode 100644 index 00000000..7e8c3f84 --- /dev/null +++ b/_examples/database/mysql/api/category_handler.go @@ -0,0 +1,251 @@ +package api + +import ( + "myapp/entity" + "myapp/service" + "myapp/sql" + + "github.com/kataras/iris/v12" +) + +// CategoryHandler is the http mux for categories. +type CategoryHandler struct { + // [...options] + + service *service.CategoryService +} + +// NewCategoryHandler returns the main controller for the categories API. +func NewCategoryHandler(service *service.CategoryService) *CategoryHandler { + return &CategoryHandler{service} +} + +// GetByID fetches a single record from the database and sends it to the client. +// Method: GET. +func (h *CategoryHandler) GetByID(ctx iris.Context) { + id := ctx.Params().GetInt64Default("id", 0) + + var cat entity.Category + err := h.service.GetByID(ctx.Request().Context(), &cat, id) + if err != nil { + if err == sql.ErrNoRows { + writeEntityNotFound(ctx) + return + } + + debugf("CategoryHandler.GetByID(id=%d): %v", id, err) + writeInternalServerError(ctx) + return + } + + ctx.JSON(cat) +} + +/* + +type ( + List struct { + Data interface{} `json:"data"` + Order string `json:"order"` + Next Range `json:"next,omitempty"` + Prev Range `json:"prev,omitempty"` + } + + Range struct { + Offset int64 `json:"offset"` + Limit int64 `json:"limit` + } +) +*/ + +// List lists a set of records from the database. +// Method: GET. +func (h *CategoryHandler) List(ctx iris.Context) { + q := ctx.Request().URL.Query() + opts := sql.ParseListOptions(q) + + // initialize here in order to return an empty json array `[]` instead of `null`. + categories := entity.Categories{} + err := h.service.List(ctx.Request().Context(), &categories, opts) + if err != nil && err != sql.ErrNoRows { + debugf("CategoryHandler.List(DB) (limit=%d offset=%d where=%s=%v): %v", + opts.Limit, opts.Offset, opts.WhereColumn, opts.WhereValue, err) + + writeInternalServerError(ctx) + return + } + + ctx.JSON(categories) +} + +// Create adds a record to the database. +// Method: POST. +func (h *CategoryHandler) Create(ctx iris.Context) { + var cat entity.Category + if err := ctx.ReadJSON(&cat); err != nil { + return + } + + id, err := h.service.Insert(ctx.Request().Context(), cat) + if err != nil { + if err == sql.ErrUnprocessable { + ctx.StopWithJSON(iris.StatusUnprocessableEntity, newError(iris.StatusUnprocessableEntity, ctx.Request().Method, ctx.Path(), "required fields are missing")) + return + } + + debugf("CategoryHandler.Create(DB): %v", err) + writeInternalServerError(ctx) + return + } + + // Send 201 with body of {"id":$last_inserted_id"}. + ctx.StatusCode(iris.StatusCreated) + ctx.JSON(iris.Map{cat.PrimaryKey(): id}) +} + +// Update performs a full-update of a record in the database. +// Method: PUT. +func (h *CategoryHandler) Update(ctx iris.Context) { + var cat entity.Category + if err := ctx.ReadJSON(&cat); err != nil { + return + } + + affected, err := h.service.Update(ctx.Request().Context(), cat) + if err != nil { + if err == sql.ErrUnprocessable { + ctx.StopWithJSON(iris.StatusUnprocessableEntity, newError(iris.StatusUnprocessableEntity, ctx.Request().Method, ctx.Path(), "required fields are missing")) + return + } + + debugf("CategoryHandler.Update(DB): %v", err) + writeInternalServerError(ctx) + return + } + + status := iris.StatusOK + if affected == 0 { + status = iris.StatusNotModified + } + + ctx.StatusCode(status) +} + +// PartialUpdate is the handler for partially update one or more fields of the record. +// Method: PATCH. +func (h *CategoryHandler) PartialUpdate(ctx iris.Context) { + id := ctx.Params().GetInt64Default("id", 0) + + var attrs map[string]interface{} + if err := ctx.ReadJSON(&attrs); err != nil { + return + } + + affected, err := h.service.PartialUpdate(ctx.Request().Context(), id, attrs) + if err != nil { + if err == sql.ErrUnprocessable { + ctx.StopWithJSON(iris.StatusUnprocessableEntity, newError(iris.StatusUnprocessableEntity, ctx.Request().Method, ctx.Path(), "unsupported value(s)")) + return + } + + debugf("CategoryHandler.PartialUpdate(DB): %v", err) + writeInternalServerError(ctx) + return + } + + status := iris.StatusOK + if affected == 0 { + status = iris.StatusNotModified + } + + ctx.StatusCode(status) +} + +// Delete removes a record from the database. +// Method: DELETE. +func (h *CategoryHandler) Delete(ctx iris.Context) { + id := ctx.Params().GetInt64Default("id", 0) + + affected, err := h.service.DeleteByID(ctx.Request().Context(), id) + if err != nil { + debugf("CategoryHandler.Delete(DB): %v", err) + writeInternalServerError(ctx) + return + } + + status := iris.StatusOK // StatusNoContent + if affected == 0 { + status = iris.StatusNotModified + } + + ctx.StatusCode(status) +} + +// Products. + +// ListProducts lists products of a Category. +// Example: from cheap to expensive: +// http://localhost:8080/category/3/products?offset=0&limit=30&by=price&order=asc +// Method: GET. +func (h *CategoryHandler) ListProducts(ctx iris.Context) { + id := ctx.Params().GetInt64Default("id", 0) + + // NOTE: could add cache here too. + + q := ctx.Request().URL.Query() + opts := sql.ParseListOptions(q).Where("category_id", id) + opts.Table = "products" + if opts.OrderByColumn == "" { + opts.OrderByColumn = "updated_at" + } + + var products entity.Products + err := h.service.List(ctx.Request().Context(), &products, opts) + if err != nil { + debugf("CategoryHandler.ListProducts(DB) (table=%s where=%s=%v limit=%d offset=%d): %v", + opts.Table, opts.WhereColumn, opts.WhereValue, opts.Limit, opts.Offset, err) + + writeInternalServerError(ctx) + return + } + + ctx.JSON(products) +} + +// InsertProducts assigns new products to a Category (accepts a list of products). +// Method: POST. +func (h *CategoryHandler) InsertProducts(productService *service.ProductService) iris.Handler { + return func(ctx iris.Context) { + categoryID := ctx.Params().GetInt64Default("id", 0) + + var products []entity.Product + if err := ctx.ReadJSON(&products); err != nil { + return + } + + for i := range products { + products[i].CategoryID = categoryID + } + + inserted, err := productService.BatchInsert(ctx.Request().Context(), products) + if err != nil { + if err == sql.ErrUnprocessable { + ctx.StopWithJSON(iris.StatusUnprocessableEntity, newError(iris.StatusUnprocessableEntity, ctx.Request().Method, ctx.Path(), "required fields are missing")) + return + } + + debugf("CategoryHandler.InsertProducts(DB): %v", err) + writeInternalServerError(ctx) + return + } + + if inserted == 0 { + ctx.StatusCode(iris.StatusNotModified) + return + } + + // Send 201 with body of {"inserted":$inserted"}. + ctx.StatusCode(iris.StatusCreated) + ctx.JSON(iris.Map{"inserted": inserted}) + } +} diff --git a/_examples/database/mysql/api/helper.go b/_examples/database/mysql/api/helper.go new file mode 100644 index 00000000..8ee14c0f --- /dev/null +++ b/_examples/database/mysql/api/helper.go @@ -0,0 +1,25 @@ +package api + +import ( + "log" + + "github.com/kataras/iris/v12" +) + +const debug = true + +func debugf(format string, args ...interface{}) { + if !debug { + return + } + + log.Printf(format, args...) +} + +func writeInternalServerError(ctx iris.Context) { + ctx.StopWithJSON(iris.StatusInternalServerError, newError(iris.StatusInternalServerError, ctx.Request().Method, ctx.Path(), "")) +} + +func writeEntityNotFound(ctx iris.Context) { + ctx.StopWithJSON(iris.StatusNotFound, newError(iris.StatusNotFound, ctx.Request().Method, ctx.Path(), "entity does not exist")) +} diff --git a/_examples/database/mysql/api/httperror.go b/_examples/database/mysql/api/httperror.go new file mode 100644 index 00000000..7b599eeb --- /dev/null +++ b/_examples/database/mysql/api/httperror.go @@ -0,0 +1,60 @@ +package api + +import ( + "fmt" + "time" + + "github.com/kataras/iris/v12" +) + +// Error holds the error sent by server to clients (JSON). +type Error struct { + StatusCode int `json:"code"` + Method string `json:"-"` + Path string `json:"-"` + Message string `json:"message"` + Timestamp int64 `json:"timestamp"` +} + +func newError(statusCode int, method, path, format string, args ...interface{}) Error { + msg := format + if len(args) > 0 { + // why we check for that? If the original error message came from our database + // and it contains fmt-reserved words + // like %s or %d we will get MISSING(=...) in our error message and we don't want that. + msg = fmt.Sprintf(msg, args...) + } + + if msg == "" { + msg = iris.StatusText(statusCode) + } + + return Error{ + StatusCode: statusCode, + Method: method, + Path: path, + Message: msg, + Timestamp: time.Now().Unix(), + } +} + +// Error implements the internal Go error interface. +func (e Error) Error() string { + return fmt.Sprintf("[%d] %s: %s: %s", e.StatusCode, e.Method, e.Path, e.Message) +} + +// Is implements the standard `errors.Is` internal interface. +// Usage: errors.Is(e, target) +func (e Error) Is(target error) bool { + if target == nil { + return false + } + + err, ok := target.(Error) + if !ok { + return false + } + + return (err.StatusCode == e.StatusCode || e.StatusCode == 0) && + (err.Message == e.Message || e.Message == "") +} diff --git a/_examples/http_request/upload-file/uploads/.gitkeep b/_examples/database/mysql/api/middleware/.gitkeep similarity index 100% rename from _examples/http_request/upload-file/uploads/.gitkeep rename to _examples/database/mysql/api/middleware/.gitkeep diff --git a/_examples/database/mysql/api/product_handler.go b/_examples/database/mysql/api/product_handler.go new file mode 100644 index 00000000..31250bf3 --- /dev/null +++ b/_examples/database/mysql/api/product_handler.go @@ -0,0 +1,173 @@ +package api + +import ( + "time" + + "myapp/cache" + "myapp/entity" + "myapp/service" + "myapp/sql" + + "github.com/kataras/iris/v12" +) + +// ProductHandler is the http mux for products. +type ProductHandler struct { + service *service.ProductService + cache *cache.Cache +} + +// NewProductHandler returns the main controller for the products API. +func NewProductHandler(service *service.ProductService) *ProductHandler { + return &ProductHandler{ + service: service, + cache: cache.New(service, "products", time.Minute), + } +} + +// GetByID fetches a single record from the database and sends it to the client. +// Method: GET. +func (h *ProductHandler) GetByID(ctx iris.Context) { + id := ctx.Params().GetString("id") + + var product []byte + err := h.cache.GetByID(ctx.Request().Context(), id, &product) + if err != nil { + if err == sql.ErrNoRows { + writeEntityNotFound(ctx) + return + } + + debugf("ProductHandler.GetByID(id=%v): %v", id, err) + writeInternalServerError(ctx) + return + } + + ctx.ContentType("application/json") + ctx.Write(product) + + // ^ Could use our simple `noCache` or implement a Cache-Control (see kataras/iris/cache for that) + // but let's keep it simple. +} + +// List lists a set of records from the database. +// Method: GET. +func (h *ProductHandler) List(ctx iris.Context) { + key := ctx.Request().URL.RawQuery + + products := []byte("[]") + err := h.cache.List(ctx.Request().Context(), key, &products) + if err != nil && err != sql.ErrNoRows { + debugf("ProductHandler.List(DB) (%s): %v", + key, err) + + writeInternalServerError(ctx) + return + } + + ctx.ContentType("application/json") + ctx.Write(products) +} + +// Create adds a record to the database. +// Method: POST. +func (h *ProductHandler) Create(ctx iris.Context) { + var product entity.Product + if err := ctx.ReadJSON(&product); err != nil { + return + } + + id, err := h.service.Insert(ctx.Request().Context(), product) + if err != nil { + if err == sql.ErrUnprocessable { + ctx.StopWithJSON(iris.StatusUnprocessableEntity, newError(iris.StatusUnprocessableEntity, ctx.Request().Method, ctx.Path(), "required fields are missing")) + return + } + + debugf("ProductHandler.Create(DB): %v", err) + writeInternalServerError(ctx) + return + } + + // Send 201 with body of {"id":$last_inserted_id"}. + ctx.StatusCode(iris.StatusCreated) + ctx.JSON(iris.Map{product.PrimaryKey(): id}) +} + +// Update performs a full-update of a record in the database. +// Method: PUT. +func (h *ProductHandler) Update(ctx iris.Context) { + var product entity.Product + if err := ctx.ReadJSON(&product); err != nil { + return + } + + affected, err := h.service.Update(ctx.Request().Context(), product) + if err != nil { + if err == sql.ErrUnprocessable { + ctx.StopWithJSON(iris.StatusUnprocessableEntity, newError(iris.StatusUnprocessableEntity, ctx.Request().Method, ctx.Path(), "required fields are missing")) + return + } + + debugf("ProductHandler.Update(DB): %v", err) + writeInternalServerError(ctx) + return + } + + status := iris.StatusOK + if affected == 0 { + status = iris.StatusNotModified + } + + ctx.StatusCode(status) +} + +// PartialUpdate is the handler for partially update one or more fields of the record. +// Method: PATCH. +func (h *ProductHandler) PartialUpdate(ctx iris.Context) { + id := ctx.Params().GetInt64Default("id", 0) + + var attrs map[string]interface{} + if err := ctx.ReadJSON(&attrs); err != nil { + return + } + + affected, err := h.service.PartialUpdate(ctx.Request().Context(), id, attrs) + if err != nil { + if err == sql.ErrUnprocessable { + ctx.StopWithJSON(iris.StatusUnprocessableEntity, newError(iris.StatusUnprocessableEntity, ctx.Request().Method, ctx.Path(), "unsupported value(s)")) + return + } + + debugf("ProductHandler.PartialUpdate(DB): %v", err) + writeInternalServerError(ctx) + return + } + + status := iris.StatusOK + if affected == 0 { + status = iris.StatusNotModified + } + + ctx.StatusCode(status) +} + +// Delete removes a record from the database. +// Method: DELETE. +func (h *ProductHandler) Delete(ctx iris.Context) { + id := ctx.Params().GetInt64Default("id", 0) + + affected, err := h.service.DeleteByID(ctx.Request().Context(), id) + if err != nil { + debugf("ProductHandler.Delete(DB): %v", err) + writeInternalServerError(ctx) + return + } + + status := iris.StatusOK // StatusNoContent + if affected == 0 { + status = iris.StatusNotModified + } + + ctx.StatusCode(status) +} diff --git a/_examples/database/mysql/cache/groupcache.go b/_examples/database/mysql/cache/groupcache.go new file mode 100644 index 00000000..4fb4e30d --- /dev/null +++ b/_examples/database/mysql/cache/groupcache.go @@ -0,0 +1,120 @@ +package cache + +import ( + "context" + "encoding/json" + "net/url" + "strconv" + "time" + + "myapp/entity" + "myapp/sql" + + "github.com/mailgun/groupcache/v2" +) + +// Service that cache will use to retrieve data. +type Service interface { + RecordInfo() sql.Record + GetByID(ctx context.Context, dest interface{}, id int64) error + List(ctx context.Context, dest interface{}, opts sql.ListOptions) error +} + +// Cache is a simple structure which holds the groupcache and the database service, exposes +// `GetByID` and `List` which returns cached (or stores new) items. +type Cache struct { + service Service + maxAge time.Duration + group *groupcache.Group +} + +// Size default size to use on groupcache, defaults to 3MB. +var Size int64 = 3 << (10 * 3) + +// New returns a new cache service which exposes `GetByID` and `List` methods to work with. +// The "name" should be unique, "maxAge" for cache expiration. +func New(service Service, name string, maxAge time.Duration) *Cache { + c := new(Cache) + c.service = service + c.maxAge = maxAge + c.group = groupcache.NewGroup(name, Size, c) + return c +} + +const ( + prefixID = "#" + prefixList = "[" +) + +// Get implements the groupcache.Getter interface. +// Use `GetByID` and `List` instead. +func (c *Cache) Get(ctx context.Context, key string, dest groupcache.Sink) error { + if len(key) < 2 { // empty or missing prefix+key, should never happen. + return sql.ErrUnprocessable + } + + var v interface{} + + prefix := key[0:1] + key = key[1:] + switch prefix { + case prefixID: + // Get by ID. + id, err := strconv.ParseInt(key, 10, 64) + if err != nil || id <= 0 { + return err + } + + switch c.service.RecordInfo().(type) { + case *entity.Category: + v = new(entity.Category) + case *entity.Product: + v = new(entity.Product) + } + + err = c.service.GetByID(ctx, v, id) + if err != nil { + return err + } + + case prefixList: + // Get a set of records, list. + q, err := url.ParseQuery(key) + if err != nil { + return err + } + opts := sql.ParseListOptions(q) + + switch c.service.RecordInfo().(type) { + case *entity.Category: + v = new(entity.Categories) + case *entity.Product: + v = new(entity.Products) + } + + err = c.service.List(ctx, v, opts) + if err != nil { + return err + } + + default: + return sql.ErrUnprocessable + } + + b, err := json.Marshal(v) + if err != nil { + return err + } + + return dest.SetBytes(b, time.Now().Add(c.maxAge)) +} + +// GetByID binds an item to "dest" an item based on its "id". +func (c *Cache) GetByID(ctx context.Context, id string, dest *[]byte) error { + return c.group.Get(ctx, prefixID+id, groupcache.AllocatingByteSliceSink(dest)) +} + +// List binds item to "dest" based on the "rawQuery" of `url.Values` for `ListOptions`. +func (c *Cache) List(ctx context.Context, rawQuery string, dest *[]byte) error { + return c.group.Get(ctx, prefixList+rawQuery, groupcache.AllocatingByteSliceSink(dest)) +} diff --git a/_examples/database/mysql/docker-compose.yml b/_examples/database/mysql/docker-compose.yml new file mode 100644 index 00000000..715a20d4 --- /dev/null +++ b/_examples/database/mysql/docker-compose.yml @@ -0,0 +1,32 @@ +version: '3.1' + +services: + db: + image: mysql + command: --default-authentication-plugin=mysql_native_password + environment: + MYSQL_ROOT_PASSWORD: dbpassword + MYSQL_DATABASE: myapp + MYSQL_USER: user_myapp + MYSQL_PASSWORD: dbpassword + tty: true + volumes: + - ./migration:/docker-entrypoint-initdb.d + app: + build: . + ports: + - 8080:8080 + environment: + PORT: 8080 + MYSQL_USER: user_myapp + MYSQL_PASSWORD: dbpassword + MYSQL_DATABASE: myapp + MYSQL_HOST: db + restart: on-failure + healthcheck: + test: ["CMD", "curl", "-f", "tcp://db:3306"] + interval: 30s + timeout: 10s + retries: 5 + depends_on: + - db \ No newline at end of file diff --git a/_examples/database/mysql/entity/category.go b/_examples/database/mysql/entity/category.go new file mode 100644 index 00000000..61dae29f --- /dev/null +++ b/_examples/database/mysql/entity/category.go @@ -0,0 +1,89 @@ +package entity + +import ( + "database/sql" + "time" +) + +// Category represents the categories entity. +// Each product belongs to a category, see `Product.CategoryID` field. +// It implements the `sql.Record` and `sql.Sorted` interfaces. +type Category struct { + ID int64 `db:"id" json:"id"` + Title string `db:"title" json:"title"` + Position uint64 `db:"position" json:"position"` + ImageURL string `db:"image_url" json:"image_url"` + + // We could use: sql.NullTime or unix time seconds (as int64), + // note that the dsn parameter "parseTime=true" is required now in order to fill this field correctly. + CreatedAt *time.Time `db:"created_at" json:"created_at"` + UpdatedAt *time.Time `db:"updated_at" json:"updated_at"` +} + +// TableName returns the database table name of a Category. +func (c *Category) TableName() string { + return "categories" +} + +// PrimaryKey returns the primary key of a Category. +func (c *Category) PrimaryKey() string { + return "id" +} + +// SortBy returns the column name that +// should be used as a fallback for sorting a set of Category. +func (c *Category) SortBy() string { + return "position" +} + +// Scan binds mysql rows to this Category. +func (c *Category) Scan(rows *sql.Rows) error { + c.CreatedAt = new(time.Time) + c.UpdatedAt = new(time.Time) + return rows.Scan(&c.ID, &c.Title, &c.Position, &c.ImageURL, &c.CreatedAt, &c.UpdatedAt) +} + +// Categories a list of categories. Implements the `Scannable` interface. +type Categories []*Category + +// Scan binds mysql rows to this Categories. +func (cs *Categories) Scan(rows *sql.Rows) (err error) { + cp := *cs + for rows.Next() { + c := new(Category) + if err = c.Scan(rows); err != nil { + return + } + cp = append(cp, c) + } + + if len(cp) == 0 { + return sql.ErrNoRows + } + + *cs = cp + + return rows.Err() +} + +/* +// The requests. +type ( + CreateCategoryRequest struct { + Title string `json:"title"` // all required. + Position uint64 `json:"position"` + ImageURL string `json:"imageURL"` + } + + UpdateCategoryRequest CreateCategoryRequest // at least 1 required. + + GetCategoryRequest struct { + ID int64 `json:"id"` // required. + } + + DeleteCategoryRequest GetCategoryRequest + + GetCategoriesRequest struct { + // [limit, offset...] + } +)*/ diff --git a/_examples/database/mysql/entity/product.go b/_examples/database/mysql/entity/product.go new file mode 100644 index 00000000..bb352fba --- /dev/null +++ b/_examples/database/mysql/entity/product.go @@ -0,0 +1,95 @@ +package entity + +import ( + "database/sql" + "time" +) + +// Product represents the products entity. +// It implements the `sql.Record` and `sql.Sorted` interfaces. +type Product struct { + ID int64 `db:"id" json:"id"` + CategoryID int64 `db:"category_id" json:"category_id"` + Title string `db:"title" json:"title"` + ImageURL string `db:"image_url" json:"image_url"` + Price float32 `db:"price" json:"price"` + Description string `db:"description" json:"description"` + CreatedAt *time.Time `db:"created_at" json:"created_at"` + UpdatedAt *time.Time `db:"updated_at" json:"updated_at"` +} + +// TableName returns the database table name of a Product. +func (p Product) TableName() string { + return "products" +} + +// PrimaryKey returns the primary key of a Product. +func (p *Product) PrimaryKey() string { + return "id" +} + +// SortBy returns the column name that +// should be used as a fallback for sorting a set of Product. +func (p *Product) SortBy() string { + return "updated_at" +} + +// ValidateInsert simple check for empty fields that should be required. +func (p *Product) ValidateInsert() bool { + return p.CategoryID > 0 && p.Title != "" && p.ImageURL != "" && p.Price > 0 /* decimal* */ && p.Description != "" +} + +// Scan binds mysql rows to this Product. +func (p *Product) Scan(rows *sql.Rows) error { + p.CreatedAt = new(time.Time) + p.UpdatedAt = new(time.Time) + return rows.Scan(&p.ID, &p.CategoryID, &p.Title, &p.ImageURL, &p.Price, &p.Description, &p.CreatedAt, &p.UpdatedAt) +} + +// Products is a list of products. Implements the `Scannable` interface. +type Products []*Product + +// Scan binds mysql rows to this Categories. +func (ps *Products) Scan(rows *sql.Rows) (err error) { + cp := *ps + for rows.Next() { + p := new(Product) + if err = p.Scan(rows); err != nil { + return + } + cp = append(cp, p) + } + + if len(cp) == 0 { + return sql.ErrNoRows + } + + *ps = cp + + return rows.Err() +} + +/* +// The requests. +type ( + CreateProductRequest struct { // all required. + CategoryID int64 `json:"categoryID"` + Title string `json:"title"` + ImageURL string `json:"imageURL"` + Price float32 `json:"price"` + Description string `json:"description"` + } + + UpdateProductRequest CreateProductRequest // at least 1 required. + + GetProductRequest struct { + ID int64 `json:"id"` // required. + } + + DeleteProductRequest GetProductRequest + + GetProductsRequest struct { + // [page, offset...] + } +) +*/ diff --git a/_examples/database/mysql/go.mod b/_examples/database/mysql/go.mod new file mode 100644 index 00000000..27f3b433 --- /dev/null +++ b/_examples/database/mysql/go.mod @@ -0,0 +1,9 @@ +module myapp + +go 1.14 + +require ( + github.com/go-sql-driver/mysql v1.5.0 + github.com/kataras/iris/v12 v12.2.0 + github.com/mailgun/groupcache/v2 v2.1.0 +) diff --git a/_examples/database/mysql/main.go b/_examples/database/mysql/main.go new file mode 100644 index 00000000..f7169c5d --- /dev/null +++ b/_examples/database/mysql/main.go @@ -0,0 +1,44 @@ +package main + +import ( + "fmt" + "log" + "os" + + "myapp/api" + "myapp/sql" + + "github.com/kataras/iris/v12" +) + +func main() { + dsn := fmt.Sprintf("%s:%s@tcp(%s:3306)/%s?parseTime=true&charset=utf8mb4&collation=utf8mb4_unicode_ci", + getenv("MYSQL_USER", "user_myapp"), + getenv("MYSQL_PASSWORD", "dbpassword"), + getenv("MYSQL_HOST", "localhost"), + getenv("MYSQL_DATABASE", "myapp"), + ) + + db, err := sql.ConnectMySQL(dsn) + if err != nil { + log.Fatalf("error connecting to the MySQL database: %v", err) + } + + secret := getenv("JWT_SECRET", "EbnJO3bwmX") + + app := iris.New() + subRouter := api.Router(db, secret) + app.PartyFunc("/", subRouter) + + addr := fmt.Sprintf(":%s", getenv("PORT", "8080")) + app.Listen(addr) +} + +func getenv(key string, def string) string { + v := os.Getenv(key) + if v == "" { + return def + } + + return v +} diff --git a/_examples/database/mysql/migration/api_category/create_category.json b/_examples/database/mysql/migration/api_category/create_category.json new file mode 100644 index 00000000..3ea1efa5 --- /dev/null +++ b/_examples/database/mysql/migration/api_category/create_category.json @@ -0,0 +1,5 @@ +{ + "title": "computer-internet", + "position": 2, + "image_url": "https://bp.pstatic.gr/public/dist/images/1mOPxYtw1k.webp" +} \ No newline at end of file diff --git a/_examples/database/mysql/migration/api_category/insert_products_category.json b/_examples/database/mysql/migration/api_category/insert_products_category.json new file mode 100644 index 00000000..02051b7d --- /dev/null +++ b/_examples/database/mysql/migration/api_category/insert_products_category.json @@ -0,0 +1,31 @@ +[{ + "title": "product-1", + "image_url": "https://images.product1.png", + "price": 42.42, + "description": "a description for product-1" +}, { + "title": "product-2", + "image_url": "https://images.product2.png", + "price": 32.1, + "description": "a description for product-2" +}, { + "title": "product-3", + "image_url": "https://images.product3.png", + "price": 52321321.32, + "description": "a description for product-3" +}, { + "title": "product-4", + "image_url": "https://images.product4.png", + "price": 77.4221, + "description": "a description for product-4" +}, { + "title": "product-5", + "image_url": "https://images.product5.png", + "price": 55.1, + "description": "a description for product-5" +}, { + "title": "product-6", + "image_url": "https://images.product6.png", + "price": 53.32, + "description": "a description for product-6" +}] \ No newline at end of file diff --git a/_examples/database/mysql/migration/api_category/update_category.json b/_examples/database/mysql/migration/api_category/update_category.json new file mode 100644 index 00000000..a3ea1397 --- /dev/null +++ b/_examples/database/mysql/migration/api_category/update_category.json @@ -0,0 +1,6 @@ +{ + "id": 2, + "position": 1, + "title": "computers", + "image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/d7/Desktop_computer_clipart_-_Yellow_theme.svg/1200px-Desktop_computer_clipart_-_Yellow_theme.svg.png" +} \ No newline at end of file diff --git a/_examples/database/mysql/migration/api_category/update_partial_category.json b/_examples/database/mysql/migration/api_category/update_partial_category.json new file mode 100644 index 00000000..730c7166 --- /dev/null +++ b/_examples/database/mysql/migration/api_category/update_partial_category.json @@ -0,0 +1,3 @@ +{ + "title": "computers-technology" +} \ No newline at end of file diff --git a/_examples/database/mysql/migration/api_postman.json b/_examples/database/mysql/migration/api_postman.json new file mode 100644 index 00000000..1ef1eba0 --- /dev/null +++ b/_examples/database/mysql/migration/api_postman.json @@ -0,0 +1,484 @@ +{ + "info": { + "_postman_id": "d3a2fdf6-9ebd-4e85-827d-385592a71fd6", + "name": "myapp (api-test)", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "item": [ + { + "name": "Category", + "item": [ + { + "name": "Create", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODk2MzkzNjd9.cYohwgUpe-Z7ac0LPpz4Adi5QXJmtwD1ZRpXrMUMPN0", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"title\": \"computer-internet\",\r\n \"position\": 1,\r\n \"image_url\": \"https://bp.pstatic.gr/public/dist/images/1mOPxYtw1k.webp\"\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "http://localhost:8080/category", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "category" + ] + }, + "description": "Create a Category" + }, + "response": [] + }, + { + "name": "Get By ID", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "http://localhost:8080/category/1", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "category", + "1" + ] + }, + "description": "Get By ID" + }, + "response": [] + }, + { + "name": "List", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, + "request": { + "method": "GET", + "header": [], + "body": { + "mode": "raw", + "raw": "" + }, + "url": { + "raw": "http://localhost:8080/category?offset=0&limit=30&order=asc", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "category" + ], + "query": [ + { + "key": "offset", + "value": "0" + }, + { + "key": "limit", + "value": "30" + }, + { + "key": "order", + "value": "asc" + } + ] + }, + "description": "Get many with limit offset" + }, + "response": [] + }, + { + "name": "Update (Full)", + "request": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODk1ODU1NjN9.PtfDS1niGoZ7pV6kplI-_q1fVKLnknQ3IwcrLZhoVCU", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\t\"id\": 1,\r\n\t\"position\": 3,\r\n \"title\": \"computers\",\r\n \"image_url\":\"https://upload.wikimedia.org/wikipedia/commons/thumb/d/d7/Desktop_computer_clipart_-_Yellow_theme.svg/1200px-Desktop_computer_clipart_-_Yellow_theme.svg.png\"\r\n}" + }, + "url": { + "raw": "http://localhost:8080/category", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "category" + ], + "query": [ + { + "key": "", + "value": null, + "disabled": true + } + ] + }, + "description": "Update a Category (full update)" + }, + "response": [] + }, + { + "name": "Delete By ID", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODk1ODU1NjN9.PtfDS1niGoZ7pV6kplI-_q1fVKLnknQ3IwcrLZhoVCU", + "type": "text" + } + ], + "url": { + "raw": "http://localhost:8080/category/1", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "category", + "1" + ] + }, + "description": "Delete a Category" + }, + "response": [] + }, + { + "name": "Update (Partial)", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODk1ODU1NjN9.PtfDS1niGoZ7pV6kplI-_q1fVKLnknQ3IwcrLZhoVCU", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"title\": \"computers-technology\"\r\n}" + }, + "url": { + "raw": "http://localhost:8080/category/1", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "category", + "3" + ] + }, + "description": "Update a Category partially, e.g. title only" + }, + "response": [] + }, + { + "name": "List Products", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "http://localhost:8080/category/1/products?offset=0&limit=30&by=price&order=asc", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "category", + "3", + "products" + ], + "query": [ + { + "key": "offset", + "value": "0" + }, + { + "key": "limit", + "value": "30" + }, + { + "key": "by", + "value": "price" + }, + { + "key": "order", + "value": "asc" + } + ] + }, + "description": "Get products from cheap to expensive" + }, + "response": [] + }, + { + "name": "Insert Products", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODk1ODU1NjN9.PtfDS1niGoZ7pV6kplI-_q1fVKLnknQ3IwcrLZhoVCU", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "[{\r\n \"title\": \"product-1\",\r\n \"image_url\": \"https://images.product1.png\",\r\n \"price\": 42.42,\r\n \"description\": \"a description for product-1\"\r\n}, {\r\n \"title\": \"product-2\",\r\n \"image_url\": \"https://images.product2.png\",\r\n \"price\": 32.1,\r\n \"description\": \"a description for product-2\"\r\n}, {\r\n \"title\": \"product-3\",\r\n \"image_url\": \"https://images.product3.png\",\r\n \"price\": 52321321.32,\r\n \"description\": \"a description for product-3\"\r\n}, {\r\n \"title\": \"product-4\",\r\n \"image_url\": \"https://images.product4.png\",\r\n \"price\": 77.4221,\r\n \"description\": \"a description for product-4\"\r\n}, {\r\n \"title\": \"product-5\",\r\n \"image_url\": \"https://images.product5.png\",\r\n \"price\": 55.1,\r\n \"description\": \"a description for product-5\"\r\n}, {\r\n \"title\": \"product-6\",\r\n \"image_url\": \"https://images.product6.png\",\r\n \"price\": 53.32,\r\n \"description\": \"a description for product-6\"\r\n}]" + }, + "url": { + "raw": "http://localhost:8080/category/1/products", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "category", + "3", + "products" + ] + }, + "description": "Batch Insert Products to a Category" + }, + "response": [] + } + ], + "protocolProfileBehavior": {} + }, + { + "name": "Product", + "item": [ + { + "name": "List", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "http://localhost:8080/product?offset=0&limit=30&by=price&order=asc", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "product" + ], + "query": [ + { + "key": "offset", + "value": "0" + }, + { + "key": "limit", + "value": "30" + }, + { + "key": "by", + "value": "price" + }, + { + "key": "order", + "value": "asc" + } + ] + }, + "description": "List products" + }, + "response": [] + }, + { + "name": "Get By ID", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "http://localhost:8080/product/1", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "product", + "1" + ] + }, + "description": "Get a Product" + }, + "response": [] + }, + { + "name": "Delete By ID", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODk1ODU1NjN9.PtfDS1niGoZ7pV6kplI-_q1fVKLnknQ3IwcrLZhoVCU", + "type": "text" + } + ], + "url": { + "raw": "http://localhost:8080/product/3", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "product", + "3" + ] + }, + "description": "Delete a Product" + }, + "response": [] + }, + { + "name": "Create", + "request": { + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODk1ODU1NjN9.PtfDS1niGoZ7pV6kplI-_q1fVKLnknQ3IwcrLZhoVCU", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"title\": \"product-1\",\r\n \"category_id\": 1,\r\n \"image_url\": \"https://images.product1.png\",\r\n \"price\": 42.42,\r\n \"description\": \"a description for product-1\"\r\n}" + }, + "url": { + "raw": "http://localhost:8080/product", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "product" + ] + }, + "description": "Create a Product (and assign a category)" + }, + "response": [] + }, + { + "name": "Update (Full)", + "request": { + "method": "PUT", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODk1ODU1NjN9.PtfDS1niGoZ7pV6kplI-_q1fVKLnknQ3IwcrLZhoVCU", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n\t\"id\":19,\r\n \"title\": \"product-9-new\",\r\n \"category_id\": 1,\r\n \"image_url\": \"https://images.product19.png\",\r\n \"price\": 20,\r\n \"description\": \"a description for product-9-new\"\r\n}" + }, + "url": { + "raw": "http://localhost:8080/product", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "product" + ] + }, + "description": "Update a Product (full-update)" + }, + "response": [] + }, + { + "name": "Update (Partial)", + "request": { + "method": "PATCH", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1ODk1ODU1NjN9.PtfDS1niGoZ7pV6kplI-_q1fVKLnknQ3IwcrLZhoVCU", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"title\": \"product-9-new-title\"\r\n}" + }, + "url": { + "raw": "http://localhost:8080/product/9", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "product", + "9" + ] + }, + "description": "Update a Product (partially)" + }, + "response": [] + } + ], + "description": "Product Client API", + "protocolProfileBehavior": {} + }, + { + "name": "Get Token", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "http://localhost:8080/token", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "8080", + "path": [ + "token" + ] + }, + "description": "Get Token to access \"write\" (create, update and delete) endpoints" + }, + "response": [] + } + ], + "protocolProfileBehavior": {} +} \ No newline at end of file diff --git a/_examples/database/mysql/migration/api_product/create_product.json b/_examples/database/mysql/migration/api_product/create_product.json new file mode 100644 index 00000000..46b6a5c8 --- /dev/null +++ b/_examples/database/mysql/migration/api_product/create_product.json @@ -0,0 +1,7 @@ +{ + "title": "product-1", + "category_id": 3, + "image_url": "https://images.product1.png", + "price": 42.42, + "description": "a description for product-1" +} \ No newline at end of file diff --git a/_examples/database/mysql/migration/api_product/update_partial_product.json b/_examples/database/mysql/migration/api_product/update_partial_product.json new file mode 100644 index 00000000..71413c13 --- /dev/null +++ b/_examples/database/mysql/migration/api_product/update_partial_product.json @@ -0,0 +1,3 @@ +{ + "title": "product-19-new-title" +} \ No newline at end of file diff --git a/_examples/database/mysql/migration/api_product/update_product.json b/_examples/database/mysql/migration/api_product/update_product.json new file mode 100644 index 00000000..d8e52662 --- /dev/null +++ b/_examples/database/mysql/migration/api_product/update_product.json @@ -0,0 +1,8 @@ +{ + "id":19, + "title": "product-19", + "category_id": 3, + "image_url": "https://images.product19.png", + "price": 20, + "description": "a description for product-19" +} \ No newline at end of file diff --git a/_examples/database/mysql/migration/db.sql b/_examples/database/mysql/migration/db.sql new file mode 100644 index 00000000..eab35314 --- /dev/null +++ b/_examples/database/mysql/migration/db.sql @@ -0,0 +1,33 @@ +CREATE DATABASE IF NOT EXISTS myapp DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; + +USE myapp; + +SET NAMES utf8mb4; +SET FOREIGN_KEY_CHECKS = 0; + +DROP TABLE IF EXISTS categories; +CREATE TABLE categories ( + id int(11) NOT NULL AUTO_INCREMENT, + title varchar(255) NOT NULL, + position int(11) NOT NULL, + image_url varchar(255) NOT NULL, + created_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, + updated_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + PRIMARY KEY (id) +); + +DROP TABLE IF EXISTS products; +CREATE TABLE products ( + id int(11) NOT NULL AUTO_INCREMENT, + category_id int, + title varchar(255) NOT NULL, + image_url varchar(255) NOT NULL, + price decimal(10,2) NOT NULL, + description text NOT NULL, + created_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP, + updated_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, + PRIMARY KEY (id), + FOREIGN KEY (category_id) REFERENCES categories(id) +); + +SET FOREIGN_KEY_CHECKS = 1; \ No newline at end of file diff --git a/_examples/database/mysql/service/category_service.go b/_examples/database/mysql/service/category_service.go new file mode 100644 index 00000000..2a151d83 --- /dev/null +++ b/_examples/database/mysql/service/category_service.go @@ -0,0 +1,74 @@ +package service + +import ( + "context" + "fmt" + "reflect" + + "myapp/entity" + "myapp/sql" +) + +// CategoryService represents the category entity service. +// Note that the given entity (request) should be already validated +// before service's calls. +type CategoryService struct { + *sql.Service +} + +// NewCategoryService returns a new category service to communicate with the database. +func NewCategoryService(db sql.Database) *CategoryService { + return &CategoryService{Service: sql.NewService(db, new(entity.Category))} +} + +// Insert stores a category to the database and returns its ID. +func (s *CategoryService) Insert(ctx context.Context, e entity.Category) (int64, error) { + if e.Title == "" || e.ImageURL == "" { + return 0, sql.ErrUnprocessable + } + + q := fmt.Sprintf(`INSERT INTO %s (title, position, image_url) + VALUES (?,?,?);`, e.TableName()) + + res, err := s.DB().Exec(ctx, q, e.Title, e.Position, e.ImageURL) + if err != nil { + return 0, err + } + + return res.LastInsertId() +} + +// Update updates a category based on its `ID`. +func (s *CategoryService) Update(ctx context.Context, e entity.Category) (int, error) { + if e.ID == 0 || e.Title == "" || e.ImageURL == "" { + return 0, sql.ErrUnprocessable + } + + q := fmt.Sprintf(`UPDATE %s + SET + title = ?, + position = ?, + image_url = ? + WHERE %s = ?;`, e.TableName(), e.PrimaryKey()) + + res, err := s.DB().Exec(ctx, q, e.Title, e.Position, e.ImageURL, e.ID) + if err != nil { + return 0, err + } + + n := sql.GetAffectedRows(res) + return n, nil +} + +// The updatable fields, separately from that we create for any possible future necessities. +var categoryUpdateSchema = map[string]reflect.Kind{ + "title": reflect.String, + "image_url": reflect.String, + "position": reflect.Int, +} + +// PartialUpdate accepts a key-value map to +// update the record based on the given "id". +func (s *CategoryService) PartialUpdate(ctx context.Context, id int64, attrs map[string]interface{}) (int, error) { + return s.Service.PartialUpdate(ctx, id, categoryUpdateSchema, attrs) +} diff --git a/_examples/database/mysql/service/category_service_test.go b/_examples/database/mysql/service/category_service_test.go new file mode 100644 index 00000000..24c6ef86 --- /dev/null +++ b/_examples/database/mysql/service/category_service_test.go @@ -0,0 +1,42 @@ +package service + +import ( + "context" + "testing" + + "myapp/entity" + "myapp/sql" + + "github.com/DATA-DOG/go-sqlmock" +) + +func TestCategoryServiceInsert(t *testing.T) { + conn, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual)) + if err != nil { + t.Fatal(err) + } + defer conn.Close() + + db := &sql.MySQL{Conn: conn} + service := NewCategoryService(db) + newCategory := entity.Category{ + Title: "computer-internet", + Position: 2, + ImageURL: "https://animage", + } + mock.ExpectExec("INSERT INTO categories (title, position, image_url) VALUES (?,?,?);"). + WithArgs(newCategory.Title, newCategory.Position, newCategory.ImageURL).WillReturnResult(sqlmock.NewResult(1, 1)) + + id, err := service.Insert(context.TODO(), newCategory) + if err != nil { + t.Fatal(err) + } + + if id != 1 { + t.Fatalf("expected ID to be 1 as this is the first entry") + } + + if err = mock.ExpectationsWereMet(); err != nil { + t.Fatal(err) + } +} diff --git a/_examples/database/mysql/service/product_service.go b/_examples/database/mysql/service/product_service.go new file mode 100644 index 00000000..15d7bfdc --- /dev/null +++ b/_examples/database/mysql/service/product_service.go @@ -0,0 +1,110 @@ +package service + +import ( + "context" + "fmt" + "reflect" + "strings" + + "myapp/entity" + "myapp/sql" +) + +// ProductService represents the product entity service. +// Note that the given entity (request) should be already validated +// before service's calls. +type ProductService struct { + *sql.Service + rec sql.Record +} + +// NewProductService returns a new product service to communicate with the database. +func NewProductService(db sql.Database) *ProductService { + return &ProductService{Service: sql.NewService(db, new(entity.Product))} +} + +// Insert stores a product to the database and returns its ID. +func (s *ProductService) Insert(ctx context.Context, e entity.Product) (int64, error) { + if !e.ValidateInsert() { + return 0, sql.ErrUnprocessable + } + + q := fmt.Sprintf(`INSERT INTO %s (category_id, title, image_url, price, description) + VALUES (?,?,?,?,?);`, e.TableName()) + + res, err := s.DB().Exec(ctx, q, e.CategoryID, e.Title, e.ImageURL, e.Price, e.Description) + if err != nil { + return 0, err + } + + return res.LastInsertId() +} + +// BatchInsert inserts one or more products at once and returns the total length created. +func (s *ProductService) BatchInsert(ctx context.Context, products []entity.Product) (int, error) { + if len(products) == 0 { + return 0, nil + } + + var ( + valuesLines []string + args []interface{} + ) + + for _, p := range products { + if !p.ValidateInsert() { + // all products should be "valid", we don't skip, we cancel. + return 0, sql.ErrUnprocessable + } + + valuesLines = append(valuesLines, "(?,?,?,?,?)") + args = append(args, []interface{}{p.CategoryID, p.Title, p.ImageURL, p.Price, p.Description}...) + } + + q := fmt.Sprintf("INSERT INTO %s (category_id, title, image_url, price, description) VALUES %s;", + s.RecordInfo().TableName(), + strings.Join(valuesLines, ", ")) + + res, err := s.DB().Exec(ctx, q, args...) + if err != nil { + return 0, err + } + + n := sql.GetAffectedRows(res) + return n, nil +} + +// Update updates a product based on its `ID` from the database +// and returns the affected numbrer (0 when nothing changed otherwise 1). +func (s *ProductService) Update(ctx context.Context, e entity.Product) (int, error) { + q := fmt.Sprintf(`UPDATE %s + SET + category_id = ?, + title = ?, + image_url = ?, + price = ?, + description = ? + WHERE %s = ?;`, e.TableName(), e.PrimaryKey()) + + res, err := s.DB().Exec(ctx, q, e.CategoryID, e.Title, e.ImageURL, e.Price, e.Description, e.ID) + if err != nil { + return 0, err + } + + n := sql.GetAffectedRows(res) + return n, nil +} + +var productUpdateSchema = map[string]reflect.Kind{ + "category_id": reflect.Int, + "title": reflect.String, + "image_url": reflect.String, + "price": reflect.Float32, + "description": reflect.String, +} + +// PartialUpdate accepts a key-value map to +// update the record based on the given "id". +func (s *ProductService) PartialUpdate(ctx context.Context, id int64, attrs map[string]interface{}) (int, error) { + return s.Service.PartialUpdate(ctx, id, productUpdateSchema, attrs) +} diff --git a/_examples/database/mysql/sql/mysql.go b/_examples/database/mysql/sql/mysql.go new file mode 100644 index 00000000..9d93b5cd --- /dev/null +++ b/_examples/database/mysql/sql/mysql.go @@ -0,0 +1,123 @@ +package sql + +import ( + "context" + "database/sql" + "fmt" + + _ "github.com/go-sql-driver/mysql" // lint: mysql driver. +) + +// MySQL holds the underline connection of a MySQL (or MariaDB) database. +// See the `ConnectMySQL` package-level function. +type MySQL struct { + Conn *sql.DB +} + +var _ Database = (*MySQL)(nil) + +var ( + // DefaultCharset default charset parameter for new databases. + DefaultCharset = "utf8mb4" + // DefaultCollation default collation parameter for new databases. + DefaultCollation = "utf8mb4_unicode_ci" +) + +// ConnectMySQL returns a new ready to use MySQL Database instance. +// Accepts a single argument of "dsn", i.e: +// username:password@tcp(localhost:3306)/myapp?parseTime=true&charset=utf8mb4&collation=utf8mb4_unicode_ci +func ConnectMySQL(dsn string) (*MySQL, error) { + conn, err := sql.Open("mysql", dsn) + if err != nil { + return nil, err + } + err = conn.Ping() + if err != nil { + conn.Close() + return nil, err + } + + return &MySQL{ + Conn: conn, + }, nil +} + +// CreateDatabase executes the CREATE DATABASE query. +func (db *MySQL) CreateDatabase(database string) error { + q := fmt.Sprintf("CREATE DATABASE %s DEFAULT CHARSET = %s COLLATE = %s;", database, DefaultCharset, DefaultCollation) + _, err := db.Conn.Exec(q) + return err +} + +// Drop executes the DROP DATABASE query. +func (db *MySQL) Drop(database string) error { + q := fmt.Sprintf("DROP DATABASE %s;", database) + _, err := db.Conn.Exec(q) + return err +} + +// Select performs the SELECT query for this database (dsn database name is required). +func (db *MySQL) Select(ctx context.Context, dest interface{}, query string, args ...interface{}) error { + rows, err := db.Conn.QueryContext(ctx, query, args...) + if err != nil { + return err + } + defer rows.Close() + + if scannable, ok := dest.(Scannable); ok { + return scannable.Scan(rows) + } + + if !rows.Next() { + return ErrNoRows + } + return rows.Scan(dest) + + /* Uncomment this and pass a slice if u want to see reflection powers <3 + v, ok := dest.(reflect.Value) + if !ok { + v = reflect.Indirect(reflect.ValueOf(dest)) + } + + sliceTyp := v.Type() + + if sliceTyp.Kind() != reflect.Slice { + sliceTyp = reflect.SliceOf(sliceTyp) + } + + sliceElementTyp := deref(sliceTyp.Elem()) + for rows.Next() { + obj := reflect.New(sliceElementTyp) + obj.Interface().(Scannable).Scan(rows) + if err != nil { + return err + } + + v.Set(reflect.Append(v, reflect.Indirect(obj))) + } + */ +} + +// Get same as `Select` but it moves the cursor to the first result. +func (db *MySQL) Get(ctx context.Context, dest interface{}, query string, args ...interface{}) error { + rows, err := db.Conn.QueryContext(ctx, query, args...) + if err != nil { + return err + } + defer rows.Close() + if !rows.Next() { + return ErrNoRows + } + + if scannable, ok := dest.(Scannable); ok { + return scannable.Scan(rows) + } + + return rows.Scan(dest) +} + +// Exec executes a query. It does not return any rows. +// Use the first output parameter to count the affected rows on UPDATE, INSERT, or DELETE. +func (db *MySQL) Exec(ctx context.Context, query string, args ...interface{}) (sql.Result, error) { + return db.Conn.ExecContext(ctx, query, args...) +} diff --git a/_examples/database/mysql/sql/service.go b/_examples/database/mysql/sql/service.go new file mode 100644 index 00000000..153a2e6b --- /dev/null +++ b/_examples/database/mysql/sql/service.go @@ -0,0 +1,243 @@ +package sql + +import ( + "context" + "database/sql" + "errors" + "fmt" + "net/url" + "reflect" + "strconv" + "strings" +) + +// Service holder for common queries. +// Note: each entity service keeps its own base Service instance. +type Service struct { + db Database + rec Record // see `Count`, `List` and `DeleteByID` methods. +} + +// NewService returns a new (SQL) base service for common operations. +func NewService(db Database, of Record) *Service { + return &Service{db: db, rec: of} +} + +// DB exposes the database instance. +func (s *Service) DB() Database { + return s.db +} + +// RecordInfo returns the record info provided through `NewService`. +func (s *Service) RecordInfo() Record { + return s.rec +} + +// ErrNoRows is returned when GET doesn't return a row. +// A shortcut of sql.ErrNoRows. +var ErrNoRows = sql.ErrNoRows + +// GetByID binds a single record from the databases to the "dest". +func (s *Service) GetByID(ctx context.Context, dest interface{}, id int64) error { + q := fmt.Sprintf("SELECT * FROM %s WHERE %s = ? LIMIT 1", s.rec.TableName(), s.rec.PrimaryKey()) + err := s.db.Get(ctx, dest, q, id) + return err + // if err != nil { + // if err == sql.ErrNoRows { + // return false, nil + // } + + // return false, err + // } + + // return true, nil +} + +// Count returns the total records count in the table. +func (s *Service) Count(ctx context.Context) (total int64, err error) { + q := fmt.Sprintf("SELECT COUNT(DISTINCT %s) FROM %s", s.rec.PrimaryKey(), s.rec.TableName()) + if err = s.db.Select(ctx, &total, q); err == sql.ErrNoRows { + err = nil + } + return +} + +// ListOptions holds the options to be passed on the `Service.List` method. +type ListOptions struct { + Table string // the table name. + Offset uint64 // inclusive. + Limit uint64 + OrderByColumn string + Order string // "ASC" or "DESC" (could be a bool type instead). + WhereColumn string + WhereValue interface{} +} + +// Where accepts a column name and column value to set +// on the WHERE clause of the result query. +// It returns a new `ListOptions` value. +// Note that this is a basic implementation which just takes care our current needs. +func (opt ListOptions) Where(colName string, colValue interface{}) ListOptions { + opt.WhereColumn = colName + opt.WhereValue = colValue + return opt +} + +// BuildQuery returns the query and the arguments that +// should be form a SELECT command. +func (opt ListOptions) BuildQuery() (q string, args []interface{}) { + q = fmt.Sprintf("SELECT * FROM %s", opt.Table) + + if opt.WhereColumn != "" && opt.WhereValue != nil { + q += fmt.Sprintf(" WHERE %s = ?", opt.WhereColumn) + args = append(args, opt.WhereValue) + } + + if opt.OrderByColumn != "" { + q += fmt.Sprintf(" ORDER BY %s %s", opt.OrderByColumn, ParseOrder(opt.Order)) + } + + if opt.Limit > 0 { + q += fmt.Sprintf(" LIMIT %d", opt.Limit) // offset below. + } + + if opt.Offset > 0 { + q += fmt.Sprintf(" OFFSET %d", opt.Offset) + } + + return +} + +// const defaultLimit = 30 // default limit if not set. + +// ParseListOptions returns a `ListOptions` from a map[string][]string. +func ParseListOptions(q url.Values) ListOptions { + offset, _ := strconv.ParseUint(q.Get("offset"), 10, 64) + limit, _ := strconv.ParseUint(q.Get("limit"), 10, 64) + order := q.Get("order") // empty, asc(...) or desc(...). + orderBy := q.Get("by") // e.g. price + + return ListOptions{Offset: offset, Limit: limit, Order: order, OrderByColumn: orderBy} +} + +// List binds one or more records from the database to the "dest". +// If the record supports ordering then it will sort by the `Sorted.OrderBy` column name(s). +// Use the "order" input parameter to set a descending order ("DESC"). +func (s *Service) List(ctx context.Context, dest interface{}, opts ListOptions) error { + // Set table and order by column from record info for `List` by options + // so it can be more flexible to perform read-only calls of other table's too. + if opts.Table == "" { + // If missing then try to set it by record info. + opts.Table = s.rec.TableName() + } + if opts.OrderByColumn == "" { + if b, ok := s.rec.(Sorted); ok { + opts.OrderByColumn = b.SortBy() + } + } + + q, args := opts.BuildQuery() + return s.db.Select(ctx, dest, q, args...) +} + +// DeleteByID removes a single record of "dest" from the database. +func (s *Service) DeleteByID(ctx context.Context, id int64) (int, error) { + q := fmt.Sprintf("DELETE FROM %s WHERE %s = ? LIMIT 1", s.rec.TableName(), s.rec.PrimaryKey()) + res, err := s.db.Exec(ctx, q, id) + if err != nil { + return 0, err + } + + return GetAffectedRows(res), nil +} + +// ErrUnprocessable indicates error caused by invalid entity (entity's key-values). +// The syntax of the request entity is correct, but it was unable to process the contained instructions +// e.g. empty or unsupported value. +// +// See `../service/XService.Insert` and `../service/XService.Update` +// and `PartialUpdate`. +var ErrUnprocessable = errors.New("invalid entity") + +// PartialUpdate accepts a columns schema and a key-value map to +// update the record based on the given "id". +// Note: Trivial string, int and boolean type validations are performed here. +func (s *Service) PartialUpdate(ctx context.Context, id int64, schema map[string]reflect.Kind, attrs map[string]interface{}) (int, error) { + if len(schema) == 0 || len(attrs) == 0 { + return 0, nil + } + + var ( + keyLines []string + values []interface{} + ) + + for key, kind := range schema { + v, ok := attrs[key] + if !ok { + continue + } + + switch v.(type) { + case string: + if kind != reflect.String { + return 0, ErrUnprocessable + } + case int: + if kind != reflect.Int { + return 0, ErrUnprocessable + } + case bool: + if kind != reflect.Bool { + return 0, ErrUnprocessable + } + } + + keyLines = append(keyLines, fmt.Sprintf("%s = ?", key)) + values = append(values, v) + } + + if len(values) == 0 { + return 0, nil + } + + q := fmt.Sprintf("UPDATE %s SET %s WHERE %s = ?;", + s.rec.TableName(), strings.Join(keyLines, ", "), s.rec.PrimaryKey()) + + res, err := s.DB().Exec(ctx, q, append(values, id)...) + if err != nil { + return 0, err + } + + n := GetAffectedRows(res) + return n, nil +} + +// GetAffectedRows returns the number of affected rows after +// a DELETE or UPDATE operation. +func GetAffectedRows(result sql.Result) int { + if result == nil { + return 0 + } + + n, _ := result.RowsAffected() + return int(n) +} + +const ( + ascending = "ASC" + descending = "DESC" +) + +// ParseOrder accept an order string and returns a valid mysql ORDER clause. +// Defaults to "ASC". Two possible outputs: "ASC" and "DESC". +func ParseOrder(order string) string { + order = strings.TrimSpace(order) + if len(order) >= 4 { + if strings.HasPrefix(strings.ToUpper(order), descending) { + return descending + } + } + + return ascending +} diff --git a/_examples/database/mysql/sql/sql.go b/_examples/database/mysql/sql/sql.go new file mode 100644 index 00000000..4ac6ec9c --- /dev/null +++ b/_examples/database/mysql/sql/sql.go @@ -0,0 +1,40 @@ +package sql + +import ( + "context" + "database/sql" +) + +// Database is an interface which a database(sql) should implement. +type Database interface { + Get(ctx context.Context, dest interface{}, q string, args ...interface{}) error + Select(ctx context.Context, dest interface{}, q string, args ...interface{}) error + Exec(ctx context.Context, q string, args ...interface{}) (sql.Result, error) +} + +// Record should represent a database record. +// It holds the table name and the primary key. +// Entities should implement that +// in order to use the BaseService's methods. +type Record interface { + TableName() string // the table name which record belongs to. + PrimaryKey() string // the primary key of the record. +} + +// Sorted should represent a set of database records +// that should be rendered with order. +// +// It does NOT support the form of +// column1 ASC, +// column2 DESC +// The OrderBy method should return text in form of: +// column1 +// or column1, column2 +type Sorted interface { + SortBy() string // column names separated by comma. +} + +// Scannable for go structs to bind their fields. +type Scannable interface { + Scan(*sql.Rows) error +} diff --git a/_examples/orm/gorm/REAMDE.md b/_examples/database/orm/gorm/REAMDE.md similarity index 100% rename from _examples/orm/gorm/REAMDE.md rename to _examples/database/orm/gorm/REAMDE.md diff --git a/_examples/orm/gorm/main.go b/_examples/database/orm/gorm/main.go similarity index 100% rename from _examples/orm/gorm/main.go rename to _examples/database/orm/gorm/main.go diff --git a/_examples/orm/xorm/main.go b/_examples/database/orm/xorm/main.go similarity index 100% rename from _examples/orm/xorm/main.go rename to _examples/database/orm/xorm/main.go diff --git a/_examples/dependency-injection/jwt/contrib/main.go b/_examples/dependency-injection/jwt/contrib/main.go new file mode 100644 index 00000000..171f2ed1 --- /dev/null +++ b/_examples/dependency-injection/jwt/contrib/main.go @@ -0,0 +1,66 @@ +package main + +import ( + "github.com/kataras/iris/v12" + + "github.com/iris-contrib/middleware/jwt" +) + +var secret = []byte("My Secret Key") + +func main() { + app := iris.New() + app.ConfigureContainer(register) + + app.Listen(":8080") +} + +func register(api *iris.APIContainer) { + j := jwt.New(jwt.Config{ + // Extract by "token" url parameter. + Extractor: jwt.FromFirst(jwt.FromParameter("token"), jwt.FromAuthHeader), + ValidationKeyGetter: func(token *jwt.Token) (interface{}, error) { + return secret, nil + }, + SigningMethod: jwt.SigningMethodHS256, + }) + + api.Get("/authenticate", writeToken) + // This works as usually: + api.Get("/restricted", j.Serve, restrictedPage) + + // You can also bind the *jwt.Token (see `verifiedWithBindedTokenPage`) + // by registering a *jwt.Token dependency. + // + // api.RegisterDependency(func(ctx iris.Context) *jwt.Token { + // if err := j.CheckJWT(ctx); err != nil { + // ctx.StopWithStatus(iris.StatusUnauthorized) + // return nil + // } + // + // token := j.Get(ctx) + // return token + // }) + // ^ You can do the same with MVC too, as the container is shared and works + // the same way in both functions-as-handlers and structs-as-controllers. + // + // api.Get("/", restrictedPageWithBindedTokenPage) +} + +func writeToken() string { + token := jwt.NewTokenWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{ + "foo": "bar", + }) + + tokenString, _ := token.SignedString(secret) + return tokenString +} + +func restrictedPage() string { + return "This page can only be seen by verified clients" +} + +func restrictedPageWithBindedTokenPage(token *jwt.Token) string { + // Token[foo] value: bar + return "Token[foo] value: " + token.Claims.(jwt.MapClaims)["foo"].(string) +} diff --git a/_examples/dependency-injection/jwt/main.go b/_examples/dependency-injection/jwt/main.go index 54b0b2bf..c705fac9 100644 --- a/_examples/dependency-injection/jwt/main.go +++ b/_examples/dependency-injection/jwt/main.go @@ -1,13 +1,12 @@ package main import ( + "time" + "github.com/kataras/iris/v12" - - "github.com/iris-contrib/middleware/jwt" + "github.com/kataras/iris/v12/middleware/jwt" ) -var secret = []byte("My Secret Key") - func main() { app := iris.New() app.ConfigureContainer(register) @@ -16,51 +15,36 @@ func main() { } func register(api *iris.APIContainer) { - j := jwt.New(jwt.Config{ - // Extract by "token" url parameter. - Extractor: jwt.FromFirst(jwt.FromParameter("token"), jwt.FromAuthHeader), - ValidationKeyGetter: func(token *jwt.Token) (interface{}, error) { - return secret, nil - }, - SigningMethod: jwt.SigningMethodHS256, + j := jwt.HMAC(15*time.Minute, "secret", "secretforencrypt") + + api.RegisterDependency(func(ctx iris.Context) (claims userClaims) { + if err := j.VerifyToken(ctx, &claims); err != nil { + ctx.StopWithError(iris.StatusUnauthorized, err) + return + } + + return }) - api.Get("/token", writeToken) - // This works as usually: - api.Get("/", j.Serve, verifiedPage) - - // You can also bind the *jwt.Token (see `verifiedWithBindedTokenPage`) - // by registering a *jwt.Token dependency. - // - // api.RegisterDependency(func(ctx iris.Context) *jwt.Token { - // if err := j.CheckJWT(ctx); err != nil { - // ctx.StopWithStatus(iris.StatusUnauthorized) - // return nil - // } - // - // token := j.Get(ctx) - // return token - // }) - // ^ You can do the same with MVC too, as the container is shared and works - // the same way in both functions-as-handlers and structs-as-controllers. - // - // api.Get("/", verifiedWithBindedTokenPage) + api.Get("/authenticate", writeToken(j)) + api.Get("/restricted", restrictedPage) } -func writeToken() string { - token := jwt.NewTokenWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{ - "foo": "bar", - }) - - tokenString, _ := token.SignedString(secret) - return tokenString +type userClaims struct { + jwt.Claims + Username string } -func verifiedPage() string { - return "This page can only be seen by verified clients" +func writeToken(j *jwt.JWT) iris.Handler { + return func(ctx iris.Context) { + j.WriteToken(ctx, userClaims{ + Claims: j.Expiry(jwt.Claims{Issuer: "an-issuer"}), + Username: "kataras", + }) + } } -func verifiedWithBindedTokenPage(token *jwt.Token) string { - // Token[foo] value: bar - return "Token[foo] value: " + token.Claims.(jwt.MapClaims)["foo"].(string) +func restrictedPage(claims userClaims) string { + // userClaims.Username: kataras + return "userClaims.Username: " + claims.Username } diff --git a/_examples/desktop-app/blink/main.go b/_examples/desktop/blink/main.go similarity index 100% rename from _examples/desktop-app/blink/main.go rename to _examples/desktop/blink/main.go diff --git a/_examples/desktop-app/lorca/main.go b/_examples/desktop/lorca/main.go similarity index 100% rename from _examples/desktop-app/lorca/main.go rename to _examples/desktop/lorca/main.go diff --git a/_examples/desktop-app/webview/main.go b/_examples/desktop/webview/main.go similarity index 100% rename from _examples/desktop-app/webview/main.go rename to _examples/desktop/webview/main.go diff --git a/_examples/tutorial/dropzonejs/README.md b/_examples/dropzonejs/README.md similarity index 96% rename from _examples/tutorial/dropzonejs/README.md rename to _examples/dropzonejs/README.md index ea449d73..2b8dda16 100644 --- a/_examples/tutorial/dropzonejs/README.md +++ b/_examples/dropzonejs/README.md @@ -1,168 +1,168 @@ -# Articles - -* [How to build a file upload form using DropzoneJS and Go](https://hackernoon.com/how-to-build-a-file-upload-form-using-dropzonejs-and-go-8fb9f258a991) -* [How to display existing files on server using DropzoneJS and Go](https://hackernoon.com/how-to-display-existing-files-on-server-using-dropzonejs-and-go-53e24b57ba19) - -# Content - -This is the part 1 of 2 in DropzoneJS + Go series. - -- [Part 1: How to build a file upload form](README.md) -- [Part 2: How to display existing files on server](README_PART2.md) - -# DropzoneJS + Go: How to build a file upload form - -[DropzoneJS](https://github.com/enyo/dropzone) is an open source library that provides drag'n'drop file uploads with image previews. It is a great JavaScript library which actually does not even rely on JQuery. -In this tutorial, we are building a multiple file upload form using DropzoneJS, and the backend will be handled by Go and [Iris](https://iris-go.com). - -## Table Of Content - -- [Preparation](#preparation) -- [Work with DropzoneJS](#work-with-dropzonejs) -- [Work with Go](#work-with-go) - -## Preparation - -1. Download [Go(Golang)](https://golang.org/dl), setup your computer as shown there and continue to 2. -2. Install [Iris](https://github.com/kataras/iris); open a terminal and execute `go get -u github.com/kataras/iris` -3. Download DropzoneJS from [this URL](https://raw.githubusercontent.com/enyo/dropzone/master/dist/dropzone.js). DropzoneJS does not rely on JQuery, you will not have to worry that, upgrading JQuery version breaks your application. -4. Download dropzone.css from [this URL](https://raw.githubusercontent.com/enyo/dropzone/master/dist/dropzone.css), if you want some already made css. -5. Create a folder "./public/uploads", this is for storing uploaded files. -6. Create a file "./views/upload.html", this is for the front form page. -7. Create a file "./main.go", this is for handling backend file upload process. - -Your folder&file structure should look like this after the preparation: - -![folder&file structure](folder_structure.png) - -## Work with DropzoneJS - -Open file "./views/upload.html" and let us create a DropzoneJs form. - -Copy the content below to "./views/upload.html" and we will go through each line of code individually. - -```html - - - - - DropzoneJS Uploader - - - - - - - - - - - -
-
- - -
-
- - - -``` - -1. Include the CSS Stylesheet. -2. Include DropzoneJS JavaScript library. -3. Create an upload form with css class "dropzone" and "action" is the route path "/upload". Note that we did create an input filed for fallback mode. This is all handled by DropzoneJS library itself. All we need to do is assign css class "dropzone" to the form. By default, DropzoneJS will find all forms with class "dropzone" and automatically attach itself to it. - -## Work with Go - -Now you have come to Last part of the tutorial. In this section, we will store files sent from DropzoneJS to the "./public/uploads" folder. - -Open "main.go" and copy the code below: - -```go -// main.go - -package main - -import ( - "os" - "io" - "strings" - - "github.com/kataras/iris/v12" -) - -const uploadsDir = "./public/uploads/" - -func main() { - app := iris.New() - - // Register templates - app.RegisterView(iris.HTML("./views", ".html")) - - // Make the /public route path to statically serve the ./public/... contents - app.HandleDir("/public", "./public") - - // Render the actual form - // GET: http://localhost:8080 - app.Get("/", func(ctx iris.Context) { - ctx.View("upload.html") - }) - - // Upload the file to the server - // POST: http://localhost:8080/upload - app.Post("/upload", iris.LimitRequestBodySize(10<<20), func(ctx iris.Context) { - // Get the file from the dropzone request - file, info, err := ctx.FormFile("file") - if err != nil { - ctx.StatusCode(iris.StatusInternalServerError) - ctx.Application().Logger().Warnf("Error while uploading: %v", err.Error()) - return - } - - defer file.Close() - fname := info.Filename - - // Create a file with the same name - // assuming that you have a folder named 'uploads' - out, err := os.OpenFile(uploadsDir+fname, - os.O_WRONLY|os.O_CREATE, 0666) - - if err != nil { - ctx.StatusCode(iris.StatusInternalServerError) - ctx.Application().Logger().Warnf("Error while preparing the new file: %v", err.Error()) - return - } - defer out.Close() - - io.Copy(out, file) - }) - - // Start the server at http://localhost:8080 - app.Listen(":8080") -} -``` - -1. Create a new Iris app. -2. Register and load templates from the "views" folder. -3. Make the "/public" route path to statically serve the ./public/... folder's contents -4. Create a route to serve the upload form. -5. Create a route to handle the POST form data from the DropzoneJS' form -6. Declare a variable for destination folder. -7. If file is sent to the page, store the file object to a temporary "file" variable. -8. Move uploaded file to destination based on the uploadsDir+uploaded file's name. - -### Running the server - -Open the terminal at the current project's folder and execute: - -```bash -$ go run main.go -Now listening on: http://localhost:8080 -Application started. Press CTRL+C to shut down. -``` - -Now go to browser, and navigate to http://localhost:8080, you should be able to see a page as below: - -![no files screenshot](no_files.png) +# Articles + +* [How to build a file upload form using DropzoneJS and Go](https://hackernoon.com/how-to-build-a-file-upload-form-using-dropzonejs-and-go-8fb9f258a991) +* [How to display existing files on server using DropzoneJS and Go](https://hackernoon.com/how-to-display-existing-files-on-server-using-dropzonejs-and-go-53e24b57ba19) + +# Content + +This is the part 1 of 2 in DropzoneJS + Go series. + +- [Part 1: How to build a file upload form](README.md) +- [Part 2: How to display existing files on server](README_PART2.md) + +# DropzoneJS + Go: How to build a file upload form + +[DropzoneJS](https://github.com/enyo/dropzone) is an open source library that provides drag'n'drop file uploads with image previews. It is a great JavaScript library which actually does not even rely on JQuery. +In this tutorial, we are building a multiple file upload form using DropzoneJS, and the backend will be handled by Go and [Iris](https://iris-go.com). + +## Table Of Content + +- [Preparation](#preparation) +- [Work with DropzoneJS](#work-with-dropzonejs) +- [Work with Go](#work-with-go) + +## Preparation + +1. Download [Go(Golang)](https://golang.org/dl), setup your computer as shown there and continue to 2. +2. Install [Iris](https://github.com/kataras/iris); open a terminal and execute `go get -u github.com/kataras/iris` +3. Download DropzoneJS from [this URL](https://raw.githubusercontent.com/enyo/dropzone/master/dist/dropzone.js). DropzoneJS does not rely on JQuery, you will not have to worry that, upgrading JQuery version breaks your application. +4. Download dropzone.css from [this URL](https://raw.githubusercontent.com/enyo/dropzone/master/dist/dropzone.css), if you want some already made css. +5. Create a folder "./public/uploads", this is for storing uploaded files. +6. Create a file "./views/upload.html", this is for the front form page. +7. Create a file "./main.go", this is for handling backend file upload process. + +Your folder&file structure should look like this after the preparation: + +![folder&file structure](folder_structure.png) + +## Work with DropzoneJS + +Open file "./views/upload.html" and let us create a DropzoneJs form. + +Copy the content below to "./views/upload.html" and we will go through each line of code individually. + +```html + + + + + DropzoneJS Uploader + + + + + + + + + + + +
+
+ + +
+
+ + + +``` + +1. Include the CSS Stylesheet. +2. Include DropzoneJS JavaScript library. +3. Create an upload form with css class "dropzone" and "action" is the route path "/upload". Note that we did create an input filed for fallback mode. This is all handled by DropzoneJS library itself. All we need to do is assign css class "dropzone" to the form. By default, DropzoneJS will find all forms with class "dropzone" and automatically attach itself to it. + +## Work with Go + +Now you have come to Last part of the tutorial. In this section, we will store files sent from DropzoneJS to the "./public/uploads" folder. + +Open "main.go" and copy the code below: + +```go +// main.go + +package main + +import ( + "os" + "io" + "strings" + + "github.com/kataras/iris/v12" +) + +const uploadsDir = "./public/uploads/" + +func main() { + app := iris.New() + + // Register templates + app.RegisterView(iris.HTML("./views", ".html")) + + // Make the /public route path to statically serve the ./public/... contents + app.HandleDir("/public", "./public") + + // Render the actual form + // GET: http://localhost:8080 + app.Get("/", func(ctx iris.Context) { + ctx.View("upload.html") + }) + + // Upload the file to the server + // POST: http://localhost:8080/upload + app.Post("/upload", iris.LimitRequestBodySize(10<<20), func(ctx iris.Context) { + // Get the file from the dropzone request + file, info, err := ctx.FormFile("file") + if err != nil { + ctx.StatusCode(iris.StatusInternalServerError) + ctx.Application().Logger().Warnf("Error while uploading: %v", err.Error()) + return + } + + defer file.Close() + fname := info.Filename + + // Create a file with the same name + // assuming that you have a folder named 'uploads' + out, err := os.OpenFile(uploadsDir+fname, + os.O_WRONLY|os.O_CREATE, 0666) + + if err != nil { + ctx.StatusCode(iris.StatusInternalServerError) + ctx.Application().Logger().Warnf("Error while preparing the new file: %v", err.Error()) + return + } + defer out.Close() + + io.Copy(out, file) + }) + + // Start the server at http://localhost:8080 + app.Listen(":8080") +} +``` + +1. Create a new Iris app. +2. Register and load templates from the "views" folder. +3. Make the "/public" route path to statically serve the ./public/... folder's contents +4. Create a route to serve the upload form. +5. Create a route to handle the POST form data from the DropzoneJS' form +6. Declare a variable for destination folder. +7. If file is sent to the page, store the file object to a temporary "file" variable. +8. Move uploaded file to destination based on the uploadsDir+uploaded file's name. + +### Running the server + +Open the terminal at the current project's folder and execute: + +```bash +$ go run main.go +Now listening on: http://localhost:8080 +Application started. Press CTRL+C to shut down. +``` + +Now go to browser, and navigate to http://localhost:8080, you should be able to see a page as below: + +![no files screenshot](no_files.png) ![with uploaded files screenshot](with_files.png) \ No newline at end of file diff --git a/_examples/tutorial/dropzonejs/README_PART2.md b/_examples/dropzonejs/README_PART2.md similarity index 96% rename from _examples/tutorial/dropzonejs/README_PART2.md rename to _examples/dropzonejs/README_PART2.md index 29233fc9..73308c21 100644 --- a/_examples/tutorial/dropzonejs/README_PART2.md +++ b/_examples/dropzonejs/README_PART2.md @@ -1,310 +1,310 @@ -# Articles - -* [How to build a file upload form using DropzoneJS and Go](https://hackernoon.com/how-to-build-a-file-upload-form-using-dropzonejs-and-go-8fb9f258a991) -* [How to display existing files on server using DropzoneJS and Go](https://hackernoon.com/how-to-display-existing-files-on-server-using-dropzonejs-and-go-53e24b57ba19) - -# Content - -This is the part 2 of 2 in DropzoneJS + Go series. - -- [Part 1: How to build a file upload form](README.md) -- [Part 2: How to display existing files on server](README_PART2.md) - -# DropzoneJS + Go: How to display existing files on server - -In this tutorial, we will show you how to display existing files on the server when using DropzoneJS and Go. This tutorial is based on [How to build a file upload form using DropzoneJS and Go](README.md). Make sure you have read it before proceeding to content in this tutorial. - -## Table Of Content - -- [Preparation](#preparation) -- [Modify the Server side](#modify-the-server-side) -- [Modify the Client side](#modify-the-client-side) -- [References](#references) -- [The End](#the-end) - -## Preparation - -Install the go package "github.com/nfnt/resize" with `go get github.com/nfnt/resize`, we need it to create thumbnails. - -In previous [tutorial](README.md). We have already set up a proper working DropzoneJs upload form. There is no additional file needed for this tutorial. What we need to do is to make some modifications to file below: - -1. main.go -2. views/upload.html - -Let us get started! - -## Modify the Server side - -In previous tutorial. All "/upload" does is to store uploaded files to the server directory "./public/uploads". So we need to add a piece of code to retrieve stored files' information (name and size), and return it in JSON format. - -Copy the content below to "main.go". Read comments for details. - -```go -// main.go - -package main - -import ( - "image/jpeg" - "image/png" - "io" - "os" - "path" - "path/filepath" - "strings" - "sync" - - "github.com/kataras/iris/v12" - - "github.com/nfnt/resize" // $ go get -u github.com/nfnt/resize -) - -const uploadsDir = "./public/uploads/" - -type uploadedFile struct { - // {name: "", size: } are the dropzone's only requirements. - Name string `json:"name"` - Size int64 `json:"size"` -} - -type uploadedFiles struct { - dir string - items []uploadedFile - mu sync.RWMutex // slices are safe but RWMutex is a good practise for you. -} - -// scan the ./public/uploads folder for any files -// add them to a new uploadedFiles list. -func scanUploads(dir string) *uploadedFiles { - f := new(uploadedFiles) - - lindex := dir[len(dir)-1] - if lindex != os.PathSeparator && lindex != '/' { - dir += string(os.PathSeparator) - } - - // create directories if necessary - // and if, then return empty uploaded files; skipping the scan. - if err := os.MkdirAll(dir, os.FileMode(0666)); err != nil { - return f - } - - // otherwise scan the given "dir" for files. - f.scan(dir) - return f -} - -func (f *uploadedFiles) scan(dir string) { - f.dir = dir - filepath.Walk(dir, func(path string, info os.FileInfo, err error) error { - - // if it's directory or a thumbnail we saved earlier, skip it. - if info.IsDir() || strings.HasPrefix(info.Name(), "thumbnail_") { - return nil - } - - f.add(info.Name(), info.Size()) - return nil - }) -} - -// add the file's Name and Size to the uploadedFiles memory list -func (f *uploadedFiles) add(name string, size int64) uploadedFile { - uf := uploadedFile{ - Name: name, - Size: size, - } - f.mu.Lock() - f.items = append(f.items, uf) - f.mu.Unlock() - - return uf -} - -// create thumbnail 100x100 -// and save that to the ./public/uploads/thumbnail_$FILENAME -func (f *uploadedFiles) createThumbnail(uf uploadedFile) { - file, err := os.Open(path.Join(f.dir, uf.Name)) - if err != nil { - return - } - defer file.Close() - - name := strings.ToLower(uf.Name) - - out, err := os.OpenFile(f.dir+"thumbnail_"+uf.Name, - os.O_WRONLY|os.O_CREATE, 0666) - if err != nil { - return - } - defer out.Close() - - if strings.HasSuffix(name, ".jpg") { - // decode jpeg into image.Image - img, err := jpeg.Decode(file) - if err != nil { - return - } - - // write new image to file - resized := resize.Thumbnail(180, 180, img, resize.Lanczos3) - jpeg.Encode(out, resized, - &jpeg.Options{Quality: jpeg.DefaultQuality}) - - } else if strings.HasSuffix(name, ".png") { - img, err := png.Decode(file) - if err != nil { - return - } - - // write new image to file - resized := resize.Thumbnail(180, 180, img, resize.Lanczos3) // slower but better res - png.Encode(out, resized) - } - // and so on... you got the point, this code can be simplify, as a practise. -} - -func main() { - app := iris.New() - app.RegisterView(iris.HTML("./views", ".html")) - - app.HandleDir("/public", "./public") - - app.Get("/", func(ctx iris.Context) { - ctx.View("upload.html") - }) - - files := scanUploads(uploadsDir) - - app.Get("/uploads", func(ctx iris.Context) { - ctx.JSON(files.items) - }) - - app.Post("/upload", iris.LimitRequestBodySize(10<<20), func(ctx iris.Context) { - // Get the file from the dropzone request - file, info, err := ctx.FormFile("file") - if err != nil { - ctx.StatusCode(iris.StatusInternalServerError) - ctx.Application().Logger().Warnf("Error while uploading: %v", err.Error()) - return - } - - defer file.Close() - fname := info.Filename - - // Create a file with the same name - // assuming that you have a folder named 'uploads' - out, err := os.OpenFile(uploadsDir+fname, - os.O_WRONLY|os.O_CREATE, 0666) - - if err != nil { - ctx.StatusCode(iris.StatusInternalServerError) - ctx.Application().Logger().Warnf("Error while preparing the new file: %v", err.Error()) - return - } - defer out.Close() - - io.Copy(out, file) - - // optionally, add that file to the list in order to be visible when refresh. - uploadedFile := files.add(fname, info.Size) - go files.createThumbnail(uploadedFile) - }) - - // start the server at http://localhost:8080 - app.Listen(":8080") -} -``` - -## Modify the Client side - -Copy content below to "./views/upload.html". We will go through modifications individually. - -```html - - - - - DropzoneJS Uploader - - - - - - - - - - - - - - - -
-
- - -
-
- - - -``` - -1. We added Jquery library into our page. This actually not for DropzoneJs directly. We are using Jquery's ajax function **$.get** only. You will see below -2. We added an ID element (my-dropzone) to the form. This is needed because we need to pass configuration values to Dropzone. And to do it, we must have an ID reference of it. So that we can configure it by assigning values to Dropzone.options.myDropzone. A lot of people face confusion when configuring Dropzone. To put it in a simple way. Do not take Dropzone as a Jquery plugin, it has its own syntax and you need to follow it. -3. This starts the main part of modification. What we did here is to pass a function to listen to Dropzone's init event. This event is called when Dropzone is initialized. -4. Retrieve files details from the new "/uploads" via ajax. -5. Create mockFile using values from server. mockFile is simply JavaScript objects with properties of name and size. Then we call Dropzone's **addedfile** and **thumbnail** functions explicitly to put existing files to Dropzone upload area and generate its thumbnail. - -### Running the server - -Open the terminal at the current project's folder and execute: - -```bash -$ go run main.go -Now listening on: http://localhost:8080 -Application started. Press CTRL+C to shut down. -``` - -If you have done it successfully. Now go and upload some images and reload the upload page. Already uploaded files should auto display in Dropzone area. - -![with uploaded files screenshot](with_files.png) - -## References - -- http://www.dropzonejs.com/#server-side-implementation -- https://www.startutorial.com/articles/view/how-to-build-a-file-upload-form-using-dropzonejs-and-php -- https://docs.iris-go.com -- https://github.com/kataras/iris/tree/master/_examples/tutorial/dropzonejs - -## The end - -Hopefully this simple tutorial helped you with your development. +# Articles + +* [How to build a file upload form using DropzoneJS and Go](https://hackernoon.com/how-to-build-a-file-upload-form-using-dropzonejs-and-go-8fb9f258a991) +* [How to display existing files on server using DropzoneJS and Go](https://hackernoon.com/how-to-display-existing-files-on-server-using-dropzonejs-and-go-53e24b57ba19) + +# Content + +This is the part 2 of 2 in DropzoneJS + Go series. + +- [Part 1: How to build a file upload form](README.md) +- [Part 2: How to display existing files on server](README_PART2.md) + +# DropzoneJS + Go: How to display existing files on server + +In this tutorial, we will show you how to display existing files on the server when using DropzoneJS and Go. This tutorial is based on [How to build a file upload form using DropzoneJS and Go](README.md). Make sure you have read it before proceeding to content in this tutorial. + +## Table Of Content + +- [Preparation](#preparation) +- [Modify the Server side](#modify-the-server-side) +- [Modify the Client side](#modify-the-client-side) +- [References](#references) +- [The End](#the-end) + +## Preparation + +Install the go package "github.com/nfnt/resize" with `go get github.com/nfnt/resize`, we need it to create thumbnails. + +In previous [tutorial](README.md). We have already set up a proper working DropzoneJs upload form. There is no additional file needed for this tutorial. What we need to do is to make some modifications to file below: + +1. main.go +2. views/upload.html + +Let us get started! + +## Modify the Server side + +In previous tutorial. All "/upload" does is to store uploaded files to the server directory "./public/uploads". So we need to add a piece of code to retrieve stored files' information (name and size), and return it in JSON format. + +Copy the content below to "main.go". Read comments for details. + +```go +// main.go + +package main + +import ( + "image/jpeg" + "image/png" + "io" + "os" + "path" + "path/filepath" + "strings" + "sync" + + "github.com/kataras/iris/v12" + + "github.com/nfnt/resize" // $ go get -u github.com/nfnt/resize +) + +const uploadsDir = "./public/uploads/" + +type uploadedFile struct { + // {name: "", size: } are the dropzone's only requirements. + Name string `json:"name"` + Size int64 `json:"size"` +} + +type uploadedFiles struct { + dir string + items []uploadedFile + mu sync.RWMutex // slices are safe but RWMutex is a good practise for you. +} + +// scan the ./public/uploads folder for any files +// add them to a new uploadedFiles list. +func scanUploads(dir string) *uploadedFiles { + f := new(uploadedFiles) + + lindex := dir[len(dir)-1] + if lindex != os.PathSeparator && lindex != '/' { + dir += string(os.PathSeparator) + } + + // create directories if necessary + // and if, then return empty uploaded files; skipping the scan. + if err := os.MkdirAll(dir, os.FileMode(0666)); err != nil { + return f + } + + // otherwise scan the given "dir" for files. + f.scan(dir) + return f +} + +func (f *uploadedFiles) scan(dir string) { + f.dir = dir + filepath.Walk(dir, func(path string, info os.FileInfo, err error) error { + + // if it's directory or a thumbnail we saved earlier, skip it. + if info.IsDir() || strings.HasPrefix(info.Name(), "thumbnail_") { + return nil + } + + f.add(info.Name(), info.Size()) + return nil + }) +} + +// add the file's Name and Size to the uploadedFiles memory list +func (f *uploadedFiles) add(name string, size int64) uploadedFile { + uf := uploadedFile{ + Name: name, + Size: size, + } + f.mu.Lock() + f.items = append(f.items, uf) + f.mu.Unlock() + + return uf +} + +// create thumbnail 100x100 +// and save that to the ./public/uploads/thumbnail_$FILENAME +func (f *uploadedFiles) createThumbnail(uf uploadedFile) { + file, err := os.Open(path.Join(f.dir, uf.Name)) + if err != nil { + return + } + defer file.Close() + + name := strings.ToLower(uf.Name) + + out, err := os.OpenFile(f.dir+"thumbnail_"+uf.Name, + os.O_WRONLY|os.O_CREATE, 0666) + if err != nil { + return + } + defer out.Close() + + if strings.HasSuffix(name, ".jpg") { + // decode jpeg into image.Image + img, err := jpeg.Decode(file) + if err != nil { + return + } + + // write new image to file + resized := resize.Thumbnail(180, 180, img, resize.Lanczos3) + jpeg.Encode(out, resized, + &jpeg.Options{Quality: jpeg.DefaultQuality}) + + } else if strings.HasSuffix(name, ".png") { + img, err := png.Decode(file) + if err != nil { + return + } + + // write new image to file + resized := resize.Thumbnail(180, 180, img, resize.Lanczos3) // slower but better res + png.Encode(out, resized) + } + // and so on... you got the point, this code can be simplify, as a practise. +} + +func main() { + app := iris.New() + app.RegisterView(iris.HTML("./views", ".html")) + + app.HandleDir("/public", "./public") + + app.Get("/", func(ctx iris.Context) { + ctx.View("upload.html") + }) + + files := scanUploads(uploadsDir) + + app.Get("/uploads", func(ctx iris.Context) { + ctx.JSON(files.items) + }) + + app.Post("/upload", iris.LimitRequestBodySize(10<<20), func(ctx iris.Context) { + // Get the file from the dropzone request + file, info, err := ctx.FormFile("file") + if err != nil { + ctx.StatusCode(iris.StatusInternalServerError) + ctx.Application().Logger().Warnf("Error while uploading: %v", err.Error()) + return + } + + defer file.Close() + fname := info.Filename + + // Create a file with the same name + // assuming that you have a folder named 'uploads' + out, err := os.OpenFile(uploadsDir+fname, + os.O_WRONLY|os.O_CREATE, 0666) + + if err != nil { + ctx.StatusCode(iris.StatusInternalServerError) + ctx.Application().Logger().Warnf("Error while preparing the new file: %v", err.Error()) + return + } + defer out.Close() + + io.Copy(out, file) + + // optionally, add that file to the list in order to be visible when refresh. + uploadedFile := files.add(fname, info.Size) + go files.createThumbnail(uploadedFile) + }) + + // start the server at http://localhost:8080 + app.Listen(":8080") +} +``` + +## Modify the Client side + +Copy content below to "./views/upload.html". We will go through modifications individually. + +```html + + + + + DropzoneJS Uploader + + + + + + + + + + + + + + + +
+
+ + +
+
+ + + +``` + +1. We added Jquery library into our page. This actually not for DropzoneJs directly. We are using Jquery's ajax function **$.get** only. You will see below +2. We added an ID element (my-dropzone) to the form. This is needed because we need to pass configuration values to Dropzone. And to do it, we must have an ID reference of it. So that we can configure it by assigning values to Dropzone.options.myDropzone. A lot of people face confusion when configuring Dropzone. To put it in a simple way. Do not take Dropzone as a Jquery plugin, it has its own syntax and you need to follow it. +3. This starts the main part of modification. What we did here is to pass a function to listen to Dropzone's init event. This event is called when Dropzone is initialized. +4. Retrieve files details from the new "/uploads" via ajax. +5. Create mockFile using values from server. mockFile is simply JavaScript objects with properties of name and size. Then we call Dropzone's **addedfile** and **thumbnail** functions explicitly to put existing files to Dropzone upload area and generate its thumbnail. + +### Running the server + +Open the terminal at the current project's folder and execute: + +```bash +$ go run main.go +Now listening on: http://localhost:8080 +Application started. Press CTRL+C to shut down. +``` + +If you have done it successfully. Now go and upload some images and reload the upload page. Already uploaded files should auto display in Dropzone area. + +![with uploaded files screenshot](with_files.png) + +## References + +- http://www.dropzonejs.com/#server-side-implementation +- https://www.startutorial.com/articles/view/how-to-build-a-file-upload-form-using-dropzonejs-and-php +- https://docs.iris-go.com +- https://github.com/kataras/iris/tree/master/_examples/dropzonejs + +## The end + +Hopefully this simple tutorial helped you with your development. If you like my post, please follow me on [Twitter](https://twitter.com/makismaropoulos) and help spread the word. I need your support to continue. \ No newline at end of file diff --git a/_examples/tutorial/dropzonejs/folder_structure.png b/_examples/dropzonejs/folder_structure.png similarity index 100% rename from _examples/tutorial/dropzonejs/folder_structure.png rename to _examples/dropzonejs/folder_structure.png diff --git a/_examples/tutorial/dropzonejs/meta.yml b/_examples/dropzonejs/meta.yml similarity index 100% rename from _examples/tutorial/dropzonejs/meta.yml rename to _examples/dropzonejs/meta.yml diff --git a/_examples/tutorial/dropzonejs/no_files.png b/_examples/dropzonejs/no_files.png similarity index 100% rename from _examples/tutorial/dropzonejs/no_files.png rename to _examples/dropzonejs/no_files.png diff --git a/_examples/tutorial/dropzonejs/src/main.go b/_examples/dropzonejs/src/main.go similarity index 100% rename from _examples/tutorial/dropzonejs/src/main.go rename to _examples/dropzonejs/src/main.go diff --git a/_examples/tutorial/dropzonejs/src/public/css/dropzone.css b/_examples/dropzonejs/src/public/css/dropzone.css similarity index 100% rename from _examples/tutorial/dropzonejs/src/public/css/dropzone.css rename to _examples/dropzonejs/src/public/css/dropzone.css diff --git a/_examples/tutorial/dropzonejs/src/public/js/dropzone.js b/_examples/dropzonejs/src/public/js/dropzone.js similarity index 100% rename from _examples/tutorial/dropzonejs/src/public/js/dropzone.js rename to _examples/dropzonejs/src/public/js/dropzone.js diff --git a/_examples/tutorial/dropzonejs/src/views/upload.html b/_examples/dropzonejs/src/views/upload.html similarity index 96% rename from _examples/tutorial/dropzonejs/src/views/upload.html rename to _examples/dropzonejs/src/views/upload.html index a7e32546..d7f00987 100644 --- a/_examples/tutorial/dropzonejs/src/views/upload.html +++ b/_examples/dropzonejs/src/views/upload.html @@ -1,53 +1,53 @@ - - - - DropzoneJS Uploader - - - - - - - - - - - - - - - -
-
- - -
-
- - + + + + DropzoneJS Uploader + + + + + + + + + + + + + + + +
+
+ + +
+
+ + \ No newline at end of file diff --git a/_examples/tutorial/dropzonejs/with_files.png b/_examples/dropzonejs/with_files.png similarity index 100% rename from _examples/tutorial/dropzonejs/with_files.png rename to _examples/dropzonejs/with_files.png diff --git a/_examples/experimental-handlers/README.md b/_examples/experimental-handlers/README.md deleted file mode 100644 index 6e21b557..00000000 --- a/_examples/experimental-handlers/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Install iris-contrib/middleware - -```sh -$ go get -u github.com/iris-contrib/middleware/... -``` \ No newline at end of file diff --git a/_examples/experimental-handlers/casbin/middleware/casbinmodel.conf b/_examples/experimental-handlers/casbin/middleware/casbinmodel.conf deleted file mode 100644 index d1b3dbd7..00000000 --- a/_examples/experimental-handlers/casbin/middleware/casbinmodel.conf +++ /dev/null @@ -1,14 +0,0 @@ -[request_definition] -r = sub, obj, act - -[policy_definition] -p = sub, obj, act - -[role_definition] -g = _, _ - -[policy_effect] -e = some(where (p.eft == allow)) - -[matchers] -m = g(r.sub, p.sub) && keyMatch(r.obj, p.obj) && (r.act == p.act || p.act == "*") \ No newline at end of file diff --git a/_examples/experimental-handlers/casbin/middleware/casbinpolicy.csv b/_examples/experimental-handlers/casbin/middleware/casbinpolicy.csv deleted file mode 100644 index 52837375..00000000 --- a/_examples/experimental-handlers/casbin/middleware/casbinpolicy.csv +++ /dev/null @@ -1,5 +0,0 @@ -p, alice, /dataset1/*, GET -p, alice, /dataset1/resource1, POST -p, bob, /dataset2/resource1, * -p, bob, /dataset2/resource2, GET -p, bob, /dataset2/folder1/*, POST \ No newline at end of file diff --git a/_examples/experimental-handlers/casbin/middleware/main.go b/_examples/experimental-handlers/casbin/middleware/main.go deleted file mode 100644 index 09b41dc0..00000000 --- a/_examples/experimental-handlers/casbin/middleware/main.go +++ /dev/null @@ -1,43 +0,0 @@ -package main - -import ( - "github.com/kataras/iris/v12" - - "github.com/casbin/casbin/v2" - cm "github.com/iris-contrib/middleware/casbin" -) - -// $ go get github.com/casbin/casbin/v2 -// $ go run main.go - -// Enforcer maps the model and the policy for the casbin service, we use this variable on the main_test too. -var Enforcer, _ = casbin.NewEnforcer("casbinmodel.conf", "casbinpolicy.csv") - -func newApp() *iris.Application { - casbinMiddleware := cm.New(Enforcer) - - app := iris.New() - app.Use(casbinMiddleware.ServeHTTP) - - app.Get("/", hi) - - app.Get("/dataset1/{p:path}", hi) // p, alice, /dataset1/*, GET - - app.Post("/dataset1/resource1", hi) - - app.Get("/dataset2/resource2", hi) - app.Post("/dataset2/folder1/{p:path}", hi) - - app.Any("/dataset2/resource1", hi) - - return app -} - -func main() { - app := newApp() - app.Listen(":8080") -} - -func hi(ctx iris.Context) { - ctx.Writef("Hello %s", cm.Username(ctx.Request())) -} diff --git a/_examples/experimental-handlers/casbin/middleware/main_test.go b/_examples/experimental-handlers/casbin/middleware/main_test.go deleted file mode 100644 index a4caf0f0..00000000 --- a/_examples/experimental-handlers/casbin/middleware/main_test.go +++ /dev/null @@ -1,48 +0,0 @@ -package main - -import ( - "testing" - - "github.com/kataras/iris/v12/httptest" -) - -func TestCasbinMiddleware(t *testing.T) { - app := newApp() - e := httptest.New(t, app, httptest.Debug(false)) - - type ttcasbin struct { - username string - path string - method string - status int - } - - tt := []ttcasbin{ - {"alice", "/dataset1/resource1", "GET", 200}, - {"alice", "/dataset1/resource1", "POST", 200}, - {"alice", "/dataset1/resource2", "GET", 200}, - {"alice", "/dataset1/resource2", "POST", 404}, - - {"bob", "/dataset2/resource1", "GET", 200}, - {"bob", "/dataset2/resource1", "POST", 200}, - {"bob", "/dataset2/resource1", "DELETE", 200}, - {"bob", "/dataset2/resource2", "GET", 200}, - {"bob", "/dataset2/resource2", "POST", 404}, - {"bob", "/dataset2/resource2", "DELETE", 404}, - - {"bob", "/dataset2/folder1/item1", "GET", 404}, - {"bob", "/dataset2/folder1/item1", "POST", 200}, - {"bob", "/dataset2/folder1/item1", "DELETE", 404}, - {"bob", "/dataset2/folder1/item2", "GET", 404}, - {"bob", "/dataset2/folder1/item2", "POST", 200}, - {"bob", "/dataset2/folder1/item2", "DELETE", 404}, - } - - for _, tt := range tt { - check(e, tt.method, tt.path, tt.username, tt.status) - } -} - -func check(e *httptest.Expect, method, path, username string, status int) { - e.Request(method, path).WithBasicAuth(username, "password").Expect().Status(status) -} diff --git a/_examples/experimental-handlers/casbin/wrapper/casbinmodel.conf b/_examples/experimental-handlers/casbin/wrapper/casbinmodel.conf deleted file mode 100644 index d1b3dbd7..00000000 --- a/_examples/experimental-handlers/casbin/wrapper/casbinmodel.conf +++ /dev/null @@ -1,14 +0,0 @@ -[request_definition] -r = sub, obj, act - -[policy_definition] -p = sub, obj, act - -[role_definition] -g = _, _ - -[policy_effect] -e = some(where (p.eft == allow)) - -[matchers] -m = g(r.sub, p.sub) && keyMatch(r.obj, p.obj) && (r.act == p.act || p.act == "*") \ No newline at end of file diff --git a/_examples/experimental-handlers/casbin/wrapper/casbinpolicy.csv b/_examples/experimental-handlers/casbin/wrapper/casbinpolicy.csv deleted file mode 100644 index 532b7b4a..00000000 --- a/_examples/experimental-handlers/casbin/wrapper/casbinpolicy.csv +++ /dev/null @@ -1,7 +0,0 @@ -p, alice, /dataset1/*, GET -p, alice, /dataset1/resource1, POST -p, bob, /dataset2/resource1, * -p, bob, /dataset2/resource2, GET -p, bob, /dataset2/folder1/*, POST -p, dataset1_admin, /dataset1/*, * -g, cathrin, dataset1_admin \ No newline at end of file diff --git a/_examples/experimental-handlers/casbin/wrapper/main.go b/_examples/experimental-handlers/casbin/wrapper/main.go deleted file mode 100644 index dbc851a4..00000000 --- a/_examples/experimental-handlers/casbin/wrapper/main.go +++ /dev/null @@ -1,43 +0,0 @@ -package main - -import ( - "github.com/kataras/iris/v12" - - "github.com/casbin/casbin/v2" - cm "github.com/iris-contrib/middleware/casbin" -) - -// $ go get github.com/casbin/casbin -// $ go run main.go - -// Enforcer maps the model and the policy for the casbin service, we use this variable on the main_test too. -var Enforcer, _ = casbin.NewEnforcer("casbinmodel.conf", "casbinpolicy.csv") - -func newApp() *iris.Application { - casbinMiddleware := cm.New(Enforcer) - - app := iris.New() - app.WrapRouter(casbinMiddleware.Wrapper()) - - app.Get("/", hi) - - app.Any("/dataset1/{p:path}", hi) // p, dataset1_admin, /dataset1/*, * && p, alice, /dataset1/*, GET - - app.Post("/dataset1/resource1", hi) - - app.Get("/dataset2/resource2", hi) - app.Post("/dataset2/folder1/{p:path}", hi) - - app.Any("/dataset2/resource1", hi) - - return app -} - -func main() { - app := newApp() - app.Listen(":8080") -} - -func hi(ctx iris.Context) { - ctx.Writef("Hello %s", cm.Username(ctx.Request())) -} diff --git a/_examples/experimental-handlers/casbin/wrapper/main_test.go b/_examples/experimental-handlers/casbin/wrapper/main_test.go deleted file mode 100644 index 4fd75286..00000000 --- a/_examples/experimental-handlers/casbin/wrapper/main_test.go +++ /dev/null @@ -1,78 +0,0 @@ -package main - -import ( - "testing" - - "github.com/kataras/iris/v12/httptest" -) - -func TestCasbinWrapper(t *testing.T) { - app := newApp() - e := httptest.New(t, app, httptest.Debug(true)) - - type ttcasbin struct { - username string - path string - method string - status int - } - - tt := []ttcasbin{ - {"alice", "/dataset1/resource1", "GET", 200}, - {"alice", "/dataset1/resource1", "POST", 200}, - {"alice", "/dataset1/resource2", "GET", 200}, - {"alice", "/dataset1/resource2", "POST", 403}, - - {"bob", "/dataset2/resource1", "GET", 200}, - {"bob", "/dataset2/resource1", "POST", 200}, - {"bob", "/dataset2/resource1", "DELETE", 200}, - {"bob", "/dataset2/resource2", "GET", 200}, - {"bob", "/dataset2/resource2", "POST", 403}, - {"bob", "/dataset2/resource2", "DELETE", 403}, - - {"bob", "/dataset2/folder1/item1", "GET", 403}, - {"bob", "/dataset2/folder1/item1", "POST", 200}, - {"bob", "/dataset2/folder1/item1", "DELETE", 403}, - {"bob", "/dataset2/folder1/item2", "GET", 403}, - {"bob", "/dataset2/folder1/item2", "POST", 200}, - {"bob", "/dataset2/folder1/item2", "DELETE", 403}, - } - - for _, tt := range tt { - check(e, tt.method, tt.path, tt.username, tt.status) - } - - println("ADMIN ROLES") - ttAdmin := []ttcasbin{ - {"cathrin", "/dataset1/item", "GET", 200}, - {"cathrin", "/dataset1/item", "POST", 200}, - {"cathrin", "/dataset1/item", "DELETE", 200}, - {"cathrin", "/dataset2/item", "GET", 403}, - {"cathrin", "/dataset2/item", "POST", 403}, - {"cathrin", "/dataset2/item", "DELETE", 403}, - } - - for _, tt := range ttAdmin { - check(e, tt.method, tt.path, tt.username, tt.status) - } - - println("ADMIN ROLE FOR cathrin DELETED") - Enforcer.DeleteRolesForUser("cathrin") - - ttAdminDeleted := []ttcasbin{ - {"cathrin", "/dataset1/item", "GET", 403}, - {"cathrin", "/dataset1/item", "POST", 403}, - {"cathrin", "/dataset1/item", "DELETE", 403}, - {"cathrin", "/dataset2/item", "GET", 403}, - {"cathrin", "/dataset2/item", "POST", 403}, - {"cathrin", "/dataset2/item", "DELETE", 403}, - } - - for _, tt := range ttAdminDeleted { - check(e, tt.method, tt.path, tt.username, tt.status) - } -} - -func check(e *httptest.Expect, method, path, username string, status int) { - e.Request(method, path).WithBasicAuth(username, "password").Expect().Status(status) -} diff --git a/_examples/experimental-handlers/cloudwatch/simple/main.go b/_examples/experimental-handlers/cloudwatch/simple/main.go deleted file mode 100644 index 134db6c0..00000000 --- a/_examples/experimental-handlers/cloudwatch/simple/main.go +++ /dev/null @@ -1,50 +0,0 @@ -package main - -import ( - "time" - - "github.com/kataras/iris/v12" - - "github.com/aws/aws-sdk-go/aws" - "github.com/aws/aws-sdk-go/service/cloudwatch" - cw "github.com/iris-contrib/middleware/cloudwatch" -) - -// $ go get github.com/aws/aws-sdk-go/... -// $ go run main.go - -func main() { - app := iris.New() - app.Use(cw.New("us-east-1", "test").ServeHTTP) - - app.Get("/", func(ctx iris.Context) { - put := cw.GetPutFunc(ctx) - - put([]*cloudwatch.MetricDatum{ - { - MetricName: aws.String("MyMetric"), - Dimensions: []*cloudwatch.Dimension{ - { - Name: aws.String("ThingOne"), - Value: aws.String("something"), - }, - { - Name: aws.String("ThingTwo"), - Value: aws.String("other"), - }, - }, - Timestamp: aws.Time(time.Now()), - Unit: aws.String("Count"), - Value: aws.Float64(42), - }, - }) - - ctx.StatusCode(iris.StatusOK) - ctx.Text("success!\n") - }) - - // http://localhost:8080 - // should give: NoCredentialProviders - // which is correct, you have to authorize your aws, we asumme that you know how to. - app.Listen(":8080") -} diff --git a/_examples/experimental-handlers/cors/simple/client/index.html b/_examples/experimental-handlers/cors/simple/client/index.html deleted file mode 100644 index f5ea7416..00000000 --- a/_examples/experimental-handlers/cors/simple/client/index.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - - Example CORS - - - - - - - \ No newline at end of file diff --git a/_examples/experimental-handlers/cors/simple/client/main.go b/_examples/experimental-handlers/cors/simple/client/main.go deleted file mode 100644 index 5b941ee4..00000000 --- a/_examples/experimental-handlers/cors/simple/client/main.go +++ /dev/null @@ -1,14 +0,0 @@ -package main - -import "github.com/kataras/iris/v12" - -func main() { - app := iris.New() - app.Get("/", func(ctx iris.Context) { - ctx.ServeFile("index.html") - }) - - // Read index.html comments, - // and then start and navigate to http://localhost:8080. - app.Listen(":8080") -} diff --git a/_examples/experimental-handlers/cors/simple/main.go b/_examples/experimental-handlers/cors/simple/main.go deleted file mode 100644 index 7d80caa9..00000000 --- a/_examples/experimental-handlers/cors/simple/main.go +++ /dev/null @@ -1,55 +0,0 @@ -package main - -import "github.com/kataras/iris/v12" - -func main() { - app := iris.New() - - crs := func(ctx iris.Context) { - ctx.Header("Access-Control-Allow-Origin", "*") - ctx.Header("Access-Control-Allow-Credentials", "true") - - if ctx.Method() == iris.MethodOptions { - ctx.Header("Access-Control-Methods", "POST, PUT, PATCH, DELETE") - ctx.Header("Access-Control-Allow-Headers", "Access-Control-Allow-Origin,Content-Type") - ctx.Header("Access-Control-Max-Age", "86400") - ctx.StatusCode(iris.StatusNoContent) - return - } - - ctx.Next() - } // or "github.com/iris-contrib/middleware/cors" - - v1 := app.Party("/api/v1", crs).AllowMethods(iris.MethodOptions) // <- important for the preflight. - { - v1.Post("/mailer", func(ctx iris.Context) { - var any iris.Map - err := ctx.ReadJSON(&any) - if err != nil { - ctx.StopWithError(iris.StatusBadRequest, err) - return - } - ctx.Application().Logger().Infof("received %#+v", any) - - ctx.JSON(iris.Map{"message": "ok"}) - }) - - v1.Get("/home", func(ctx iris.Context) { - ctx.WriteString("Hello from /home") - }) - v1.Get("/about", func(ctx iris.Context) { - ctx.WriteString("Hello from /about") - }) - v1.Post("/send", func(ctx iris.Context) { - ctx.WriteString("sent") - }) - v1.Put("/send", func(ctx iris.Context) { - ctx.WriteString("updated") - }) - v1.Delete("/send", func(ctx iris.Context) { - ctx.WriteString("deleted") - }) - } - - app.Listen(":80", iris.WithTunneling) -} diff --git a/_examples/experimental-handlers/csrf/main.go b/_examples/experimental-handlers/csrf/main.go deleted file mode 100644 index 2a08814c..00000000 --- a/_examples/experimental-handlers/csrf/main.go +++ /dev/null @@ -1,55 +0,0 @@ -// This middleware provides Cross-Site Request Forgery -// protection. -// -// It securely generates a masked (unique-per-request) token that -// can be embedded in the HTTP response (e.g. form field or HTTP header). -// The original (unmasked) token is stored in the session, which is inaccessible -// by an attacker (provided you are using HTTPS). Subsequent requests are -// expected to include this token, which is compared against the session token. -// Requests that do not provide a matching token are served with a HTTP 403 -// 'Forbidden' error response. -package main - -// $ go get -u github.com/iris-contrib/middleware/... - -import ( - "github.com/kataras/iris/v12" - - "github.com/iris-contrib/middleware/csrf" -) - -func main() { - app := iris.New() - app.RegisterView(iris.HTML("./views", ".html")) - // Note that the authentication key provided should be 32 bytes - // long and persist across application restarts. - protect := csrf.Protect([]byte("9AB0F421E53A477C084477AEA06096F5"), - csrf.Secure(false)) // Defaults to true, but pass `false` while no https (devmode). - - users := app.Party("/user", protect) - { - users.Get("/signup", getSignupForm) - // // POST requests without a valid token will return a HTTP 403 Forbidden. - users.Post("/signup", postSignupForm) - } - - // GET: http://localhost:8080/user/signup - // POST: http://localhost:8080/user/signup - app.Listen(":8080") -} - -func getSignupForm(ctx iris.Context) { - // views/user/signup.html just needs a {{ .csrfField }} template tag for - // csrf.TemplateField to inject the CSRF token into. Easy! - ctx.ViewData(csrf.TemplateTag, csrf.TemplateField(ctx)) - ctx.View("user/signup.html") - - // We could also retrieve the token directly from csrf.Token(ctx) and - // set it in the request header - ctx.GetHeader("X-CSRF-Token", token) - // This is useful if you're sending JSON to clients or a front-end JavaScript - // framework. -} - -func postSignupForm(ctx iris.Context) { - ctx.Writef("You're welcome mate!") -} diff --git a/_examples/experimental-handlers/csrf/views/user/signup.html b/_examples/experimental-handlers/csrf/views/user/signup.html deleted file mode 100644 index eea693d6..00000000 --- a/_examples/experimental-handlers/csrf/views/user/signup.html +++ /dev/null @@ -1,4 +0,0 @@ -
- {{ .csrfField }} - -
diff --git a/_examples/experimental-handlers/jwt/main.go b/_examples/experimental-handlers/jwt/main.go deleted file mode 100644 index 9fe4cb91..00000000 --- a/_examples/experimental-handlers/jwt/main.go +++ /dev/null @@ -1,56 +0,0 @@ -// iris provides some basic middleware, most for your learning curve. -// You can use any net/http compatible middleware with iris.FromStd wrapper. -// -// JWT net/http video tutorial for golang newcomers: https://www.youtube.com/watch?v=dgJFeqeXVKw -// -// This middleware is the only one cloned from external source: https://github.com/auth0/go-jwt-middleware -// (because it used "context" to define the user but we don't need that so a simple iris.FromStd wouldn't work as expected.) -package main - -import ( - "github.com/kataras/iris/v12" - - "github.com/iris-contrib/middleware/jwt" -) - -func getTokenHandler(ctx iris.Context) { - token := jwt.NewTokenWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{ - "foo": "bar", - }) - - // Sign and get the complete encoded token as a string using the secret - tokenString, _ := token.SignedString([]byte("My Secret")) - - ctx.HTML(`Token: ` + tokenString + `

- /secured?token=` + tokenString + ``) -} - -func myAuthenticatedHandler(ctx iris.Context) { - user := ctx.Values().Get("jwt").(*jwt.Token) - - ctx.Writef("This is an authenticated request\n") - ctx.Writef("Claim content:\n") - - foobar := user.Claims.(jwt.MapClaims) - for key, value := range foobar { - ctx.Writef("%s = %s", key, value) - } -} - -func main() { - app := iris.New() - - j := jwt.New(jwt.Config{ - // Extract by "token" url parameter. - Extractor: jwt.FromParameter("token"), - - ValidationKeyGetter: func(token *jwt.Token) (interface{}, error) { - return []byte("My Secret"), nil - }, - SigningMethod: jwt.SigningMethodHS256, - }) - - app.Get("/", getTokenHandler) - app.Get("/secured", j.Serve, myAuthenticatedHandler) - app.Listen(":8080") -} diff --git a/_examples/experimental-handlers/newrelic/simple/main.go b/_examples/experimental-handlers/newrelic/simple/main.go deleted file mode 100644 index dbd0d558..00000000 --- a/_examples/experimental-handlers/newrelic/simple/main.go +++ /dev/null @@ -1,24 +0,0 @@ -package main - -import ( - "github.com/kataras/iris/v12" - - "github.com/iris-contrib/middleware/newrelic" -) - -func main() { - app := iris.New() - config := newrelic.Config("APP_SERVER_NAME", "NEWRELIC_LICENSE_KEY") - config.Enabled = true - m, err := newrelic.New(config) - if err != nil { - app.Logger().Fatal(err) - } - app.Use(m.ServeHTTP) - - app.Get("/", func(ctx iris.Context) { - ctx.Writef("success!\n") - }) - - app.Listen(":8080") -} diff --git a/_examples/experimental-handlers/prometheus/simple/main.go b/_examples/experimental-handlers/prometheus/simple/main.go deleted file mode 100644 index 6c2011d2..00000000 --- a/_examples/experimental-handlers/prometheus/simple/main.go +++ /dev/null @@ -1,39 +0,0 @@ -package main - -import ( - "math/rand" - "time" - - "github.com/kataras/iris/v12" - - prometheusMiddleware "github.com/iris-contrib/middleware/prometheus" - "github.com/prometheus/client_golang/prometheus/promhttp" -) - -func main() { - app := iris.New() - m := prometheusMiddleware.New("serviceName", 0.3, 1.2, 5.0) - - app.Use(m.ServeHTTP) - - app.OnErrorCode(iris.StatusNotFound, func(ctx iris.Context) { - // error code handlers are not sharing the same middleware as other routes, so we have - // to call them inside their body. - m.ServeHTTP(ctx) - - ctx.Writef("Not Found") - }) - - app.Get("/", func(ctx iris.Context) { - sleep := rand.Intn(4999) + 1 - time.Sleep(time.Duration(sleep) * time.Millisecond) - ctx.Writef("Slept for %d milliseconds", sleep) - }) - - app.Get("/metrics", iris.FromStd(promhttp.Handler())) - - // http://localhost:8080/ - // http://localhost:8080/anotfound - // http://localhost:8080/metrics - app.Listen(":8080") -} diff --git a/_examples/experimental-handlers/secure/simple/main.go b/_examples/experimental-handlers/secure/simple/main.go deleted file mode 100644 index be86a876..00000000 --- a/_examples/experimental-handlers/secure/simple/main.go +++ /dev/null @@ -1,38 +0,0 @@ -package main - -import ( - "github.com/kataras/iris/v12" - - "github.com/iris-contrib/middleware/secure" -) - -func main() { - s := secure.New(secure.Options{ - AllowedHosts: []string{"ssl.example.com"}, // AllowedHosts is a list of fully qualified domain names that are allowed. Default is empty list, which allows any and all host names. - SSLRedirect: true, // If SSLRedirect is set to true, then only allow HTTPS requests. Default is false. - SSLTemporaryRedirect: false, // If SSLTemporaryRedirect is true, the a 302 will be used while redirecting. Default is false (301). - SSLHost: "ssl.example.com", // SSLHost is the host name that is used to redirect HTTP requests to HTTPS. Default is "", which indicates to use the same host. - SSLProxyHeaders: map[string]string{"X-Forwarded-Proto": "https"}, // SSLProxyHeaders is set of header keys with associated values that would indicate a valid HTTPS request. Useful when using Nginx: `map[string]string{"X-Forwarded-Proto": "https"}`. Default is blank map. - STSSeconds: 315360000, // STSSeconds is the max-age of the Strict-Transport-Security header. Default is 0, which would NOT include the header. - STSIncludeSubdomains: true, // If STSIncludeSubdomains is set to true, the `includeSubdomains` will be appended to the Strict-Transport-Security header. Default is false. - STSPreload: true, // If STSPreload is set to true, the `preload` flag will be appended to the Strict-Transport-Security header. Default is false. - ForceSTSHeader: false, // STS header is only included when the connection is HTTPS. If you want to force it to always be added, set to true. `IsDevelopment` still overrides this. Default is false. - FrameDeny: true, // If FrameDeny is set to true, adds the X-Frame-Options header with the value of `DENY`. Default is false. - CustomFrameOptionsValue: "SAMEORIGIN", // CustomFrameOptionsValue allows the X-Frame-Options header value to be set with a custom value. This overrides the FrameDeny option. - ContentTypeNosniff: true, // If ContentTypeNosniff is true, adds the X-Content-Type-Options header with the value `nosniff`. Default is false. - BrowserXSSFilter: true, // If BrowserXssFilter is true, adds the X-XSS-Protection header with the value `1; mode=block`. Default is false. - ContentSecurityPolicy: "default-src 'self'", // ContentSecurityPolicy allows the Content-Security-Policy header value to be set with a custom value. Default is "". - PublicKey: `pin-sha256="base64+primary=="; pin-sha256="base64+backup=="; max-age=5184000; includeSubdomains; report-uri="https://www.example.com/hpkp-report"`, // PublicKey implements HPKP to prevent MITM attacks with forged certificates. Default is "". - - IsDevelopment: true, // This will cause the AllowedHosts, SSLRedirect, and STSSeconds/STSIncludeSubdomains options to be ignored during development. When deploying to production, be sure to set this to false. - }) - - app := iris.New() - app.Use(s.Serve) - - app.Get("/home", func(ctx iris.Context) { - ctx.Writef("Hello from /home") - }) - - app.Listen(":8080") -} diff --git a/_examples/experimental-handlers/tollboothic/limit-handler/main.go b/_examples/experimental-handlers/tollboothic/limit-handler/main.go deleted file mode 100644 index db52dcad..00000000 --- a/_examples/experimental-handlers/tollboothic/limit-handler/main.go +++ /dev/null @@ -1,31 +0,0 @@ -package main - -import ( - "github.com/kataras/iris/v12" - - "github.com/didip/tollbooth" - "github.com/iris-contrib/middleware/tollboothic" -) - -// $ go get github.com/didip/tollbooth -// $ go run main.go - -func main() { - app := iris.New() - - limiter := tollbooth.NewLimiter(1, nil) - // - // or create a limiter with expirable token buckets - // This setting means: - // create a 1 request/second limiter and - // every token bucket in it will expire 1 hour after it was initially set. - // limiter := tollbooth.NewLimiter(1, &limiter.ExpirableOptions{DefaultExpirationTTL: time.Hour}) - - app.Get("/", tollboothic.LimitHandler(limiter), func(ctx iris.Context) { - ctx.HTML("Hello, world!") - }) - - app.Listen(":8080") -} - -// Read more at: https://github.com/didip/tollbooth diff --git a/_examples/file-server/basic/assets/js/jquery-2.1.1.js b/_examples/file-server/basic/assets/js/jquery-2.1.1.js index 684c52c9..07f93514 100644 --- a/_examples/file-server/basic/assets/js/jquery-2.1.1.js +++ b/_examples/file-server/basic/assets/js/jquery-2.1.1.js @@ -1,9190 +1 @@ -/*! - * jQuery JavaScript Library v2.1.1 - * http://jquery.com/ - * - * Includes Sizzle.js - * http://sizzlejs.com/ - * - * Copyright 2005, 2014 jQuery Foundation, Inc. and other contributors - * Released under the MIT license - * http://jquery.org/license - * - * Date: 2014-05-01T17:11Z - */ - -(function( global, factory ) { - - if ( typeof module === "object" && typeof module.exports === "object" ) { - // For CommonJS and CommonJS-like environments where a proper window is present, - // execute the factory and get jQuery - // For environments that do not inherently posses a window with a document - // (such as Node.js), expose a jQuery-making factory as module.exports - // This accentuates the need for the creation of a real window - // e.g. var jQuery = require("jquery")(window); - // See ticket #14549 for more info - module.exports = global.document ? - factory( global, true ) : - function( w ) { - if ( !w.document ) { - throw new Error( "jQuery requires a window with a document" ); - } - return factory( w ); - }; - } else { - factory( global ); - } - -// Pass this if window is not defined yet -}(typeof window !== "undefined" ? window : this, function( window, noGlobal ) { - -// Can't do this because several apps including ASP.NET trace -// the stack via arguments.caller.callee and Firefox dies if -// you try to trace through "use strict" call chains. (#13335) -// Support: Firefox 18+ -// - -var arr = []; - -var slice = arr.slice; - -var concat = arr.concat; - -var push = arr.push; - -var indexOf = arr.indexOf; - -var class2type = {}; - -var toString = class2type.toString; - -var hasOwn = class2type.hasOwnProperty; - -var support = {}; - - - -var - // Use the correct document accordingly with window argument (sandbox) - document = window.document, - - version = "2.1.1", - - // Define a local copy of jQuery - jQuery = function( selector, context ) { - // The jQuery object is actually just the init constructor 'enhanced' - // Need init if jQuery is called (just allow error to be thrown if not included) - return new jQuery.fn.init( selector, context ); - }, - - // Support: Android<4.1 - // Make sure we trim BOM and NBSP - rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, - - // Matches dashed string for camelizing - rmsPrefix = /^-ms-/, - rdashAlpha = /-([\da-z])/gi, - - // Used by jQuery.camelCase as callback to replace() - fcamelCase = function( all, letter ) { - return letter.toUpperCase(); - }; - -jQuery.fn = jQuery.prototype = { - // The current version of jQuery being used - jquery: version, - - constructor: jQuery, - - // Start with an empty selector - selector: "", - - // The default length of a jQuery object is 0 - length: 0, - - toArray: function() { - return slice.call( this ); - }, - - // Get the Nth element in the matched element set OR - // Get the whole matched element set as a clean array - get: function( num ) { - return num != null ? - - // Return just the one element from the set - ( num < 0 ? this[ num + this.length ] : this[ num ] ) : - - // Return all the elements in a clean array - slice.call( this ); - }, - - // Take an array of elements and push it onto the stack - // (returning the new matched element set) - pushStack: function( elems ) { - - // Build a new jQuery matched element set - var ret = jQuery.merge( this.constructor(), elems ); - - // Add the old object onto the stack (as a reference) - ret.prevObject = this; - ret.context = this.context; - - // Return the newly-formed element set - return ret; - }, - - // Execute a callback for every element in the matched set. - // (You can seed the arguments with an array of args, but this is - // only used internally.) - each: function( callback, args ) { - return jQuery.each( this, callback, args ); - }, - - map: function( callback ) { - return this.pushStack( jQuery.map(this, function( elem, i ) { - return callback.call( elem, i, elem ); - })); - }, - - slice: function() { - return this.pushStack( slice.apply( this, arguments ) ); - }, - - first: function() { - return this.eq( 0 ); - }, - - last: function() { - return this.eq( -1 ); - }, - - eq: function( i ) { - var len = this.length, - j = +i + ( i < 0 ? len : 0 ); - return this.pushStack( j >= 0 && j < len ? [ this[j] ] : [] ); - }, - - end: function() { - return this.prevObject || this.constructor(null); - }, - - // For internal use only. - // Behaves like an Array's method, not like a jQuery method. - push: push, - sort: arr.sort, - splice: arr.splice -}; - -jQuery.extend = jQuery.fn.extend = function() { - var options, name, src, copy, copyIsArray, clone, - target = arguments[0] || {}, - i = 1, - length = arguments.length, - deep = false; - - // Handle a deep copy situation - if ( typeof target === "boolean" ) { - deep = target; - - // skip the boolean and the target - target = arguments[ i ] || {}; - i++; - } - - // Handle case when target is a string or something (possible in deep copy) - if ( typeof target !== "object" && !jQuery.isFunction(target) ) { - target = {}; - } - - // extend jQuery itself if only one argument is passed - if ( i === length ) { - target = this; - i--; - } - - for ( ; i < length; i++ ) { - // Only deal with non-null/undefined values - if ( (options = arguments[ i ]) != null ) { - // Extend the base object - for ( name in options ) { - src = target[ name ]; - copy = options[ name ]; - - // Prevent never-ending loop - if ( target === copy ) { - continue; - } - - // Recurse if we're merging plain objects or arrays - if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) { - if ( copyIsArray ) { - copyIsArray = false; - clone = src && jQuery.isArray(src) ? src : []; - - } else { - clone = src && jQuery.isPlainObject(src) ? src : {}; - } - - // Never move original objects, clone them - target[ name ] = jQuery.extend( deep, clone, copy ); - - // Don't bring in undefined values - } else if ( copy !== undefined ) { - target[ name ] = copy; - } - } - } - } - - // Return the modified object - return target; -}; - -jQuery.extend({ - // Unique for each copy of jQuery on the page - expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), - - // Assume jQuery is ready without the ready module - isReady: true, - - error: function( msg ) { - throw new Error( msg ); - }, - - noop: function() {}, - - // See test/unit/core.js for details concerning isFunction. - // Since version 1.3, DOM methods and functions like alert - // aren't supported. They return false on IE (#2968). - isFunction: function( obj ) { - return jQuery.type(obj) === "function"; - }, - - isArray: Array.isArray, - - isWindow: function( obj ) { - return obj != null && obj === obj.window; - }, - - isNumeric: function( obj ) { - // parseFloat NaNs numeric-cast false positives (null|true|false|"") - // ...but misinterprets leading-number strings, particularly hex literals ("0x...") - // subtraction forces infinities to NaN - return !jQuery.isArray( obj ) && obj - parseFloat( obj ) >= 0; - }, - - isPlainObject: function( obj ) { - // Not plain objects: - // - Any object or value whose internal [[Class]] property is not "[object Object]" - // - DOM nodes - // - window - if ( jQuery.type( obj ) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) { - return false; - } - - if ( obj.constructor && - !hasOwn.call( obj.constructor.prototype, "isPrototypeOf" ) ) { - return false; - } - - // If the function hasn't returned already, we're confident that - // |obj| is a plain object, created by {} or constructed with new Object - return true; - }, - - isEmptyObject: function( obj ) { - var name; - for ( name in obj ) { - return false; - } - return true; - }, - - type: function( obj ) { - if ( obj == null ) { - return obj + ""; - } - // Support: Android < 4.0, iOS < 6 (functionish RegExp) - return typeof obj === "object" || typeof obj === "function" ? - class2type[ toString.call(obj) ] || "object" : - typeof obj; - }, - - // Evaluates a script in a global context - globalEval: function( code ) { - var script, - indirect = eval; - - code = jQuery.trim( code ); - - if ( code ) { - // If the code includes a valid, prologue position - // strict mode pragma, execute code by injecting a - // script tag into the document. - if ( code.indexOf("use strict") === 1 ) { - script = document.createElement("script"); - script.text = code; - document.head.appendChild( script ).parentNode.removeChild( script ); - } else { - // Otherwise, avoid the DOM node creation, insertion - // and removal by using an indirect global eval - indirect( code ); - } - } - }, - - // Convert dashed to camelCase; used by the css and data modules - // Microsoft forgot to hump their vendor prefix (#9572) - camelCase: function( string ) { - return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); - }, - - nodeName: function( elem, name ) { - return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); - }, - - // args is for internal usage only - each: function( obj, callback, args ) { - var value, - i = 0, - length = obj.length, - isArray = isArraylike( obj ); - - if ( args ) { - if ( isArray ) { - for ( ; i < length; i++ ) { - value = callback.apply( obj[ i ], args ); - - if ( value === false ) { - break; - } - } - } else { - for ( i in obj ) { - value = callback.apply( obj[ i ], args ); - - if ( value === false ) { - break; - } - } - } - - // A special, fast, case for the most common use of each - } else { - if ( isArray ) { - for ( ; i < length; i++ ) { - value = callback.call( obj[ i ], i, obj[ i ] ); - - if ( value === false ) { - break; - } - } - } else { - for ( i in obj ) { - value = callback.call( obj[ i ], i, obj[ i ] ); - - if ( value === false ) { - break; - } - } - } - } - - return obj; - }, - - // Support: Android<4.1 - trim: function( text ) { - return text == null ? - "" : - ( text + "" ).replace( rtrim, "" ); - }, - - // results is for internal usage only - makeArray: function( arr, results ) { - var ret = results || []; - - if ( arr != null ) { - if ( isArraylike( Object(arr) ) ) { - jQuery.merge( ret, - typeof arr === "string" ? - [ arr ] : arr - ); - } else { - push.call( ret, arr ); - } - } - - return ret; - }, - - inArray: function( elem, arr, i ) { - return arr == null ? -1 : indexOf.call( arr, elem, i ); - }, - - merge: function( first, second ) { - var len = +second.length, - j = 0, - i = first.length; - - for ( ; j < len; j++ ) { - first[ i++ ] = second[ j ]; - } - - first.length = i; - - return first; - }, - - grep: function( elems, callback, invert ) { - var callbackInverse, - matches = [], - i = 0, - length = elems.length, - callbackExpect = !invert; - - // Go through the array, only saving the items - // that pass the validator function - for ( ; i < length; i++ ) { - callbackInverse = !callback( elems[ i ], i ); - if ( callbackInverse !== callbackExpect ) { - matches.push( elems[ i ] ); - } - } - - return matches; - }, - - // arg is for internal usage only - map: function( elems, callback, arg ) { - var value, - i = 0, - length = elems.length, - isArray = isArraylike( elems ), - ret = []; - - // Go through the array, translating each of the items to their new values - if ( isArray ) { - for ( ; i < length; i++ ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - - // Go through every key on the object, - } else { - for ( i in elems ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - } - - // Flatten any nested arrays - return concat.apply( [], ret ); - }, - - // A global GUID counter for objects - guid: 1, - - // Bind a function to a context, optionally partially applying any - // arguments. - proxy: function( fn, context ) { - var tmp, args, proxy; - - if ( typeof context === "string" ) { - tmp = fn[ context ]; - context = fn; - fn = tmp; - } - - // Quick check to determine if target is callable, in the spec - // this throws a TypeError, but we will just return undefined. - if ( !jQuery.isFunction( fn ) ) { - return undefined; - } - - // Simulated bind - args = slice.call( arguments, 2 ); - proxy = function() { - return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); - }; - - // Set the guid of unique handler to the same of original handler, so it can be removed - proxy.guid = fn.guid = fn.guid || jQuery.guid++; - - return proxy; - }, - - now: Date.now, - - // jQuery.support is not used in Core but other projects attach their - // properties to it so it needs to exist. - support: support -}); - -// Populate the class2type map -jQuery.each("Boolean Number String Function Array Date RegExp Object Error".split(" "), function(i, name) { - class2type[ "[object " + name + "]" ] = name.toLowerCase(); -}); - -function isArraylike( obj ) { - var length = obj.length, - type = jQuery.type( obj ); - - if ( type === "function" || jQuery.isWindow( obj ) ) { - return false; - } - - if ( obj.nodeType === 1 && length ) { - return true; - } - - return type === "array" || length === 0 || - typeof length === "number" && length > 0 && ( length - 1 ) in obj; -} -var Sizzle = -/*! - * Sizzle CSS Selector Engine v1.10.19 - * http://sizzlejs.com/ - * - * Copyright 2013 jQuery Foundation, Inc. and other contributors - * Released under the MIT license - * http://jquery.org/license - * - * Date: 2014-04-18 - */ -(function( window ) { - -var i, - support, - Expr, - getText, - isXML, - tokenize, - compile, - select, - outermostContext, - sortInput, - hasDuplicate, - - // Local document vars - setDocument, - document, - docElem, - documentIsHTML, - rbuggyQSA, - rbuggyMatches, - matches, - contains, - - // Instance-specific data - expando = "sizzle" + -(new Date()), - preferredDoc = window.document, - dirruns = 0, - done = 0, - classCache = createCache(), - tokenCache = createCache(), - compilerCache = createCache(), - sortOrder = function( a, b ) { - if ( a === b ) { - hasDuplicate = true; - } - return 0; - }, - - // General-purpose constants - strundefined = typeof undefined, - MAX_NEGATIVE = 1 << 31, - - // Instance methods - hasOwn = ({}).hasOwnProperty, - arr = [], - pop = arr.pop, - push_native = arr.push, - push = arr.push, - slice = arr.slice, - // Use a stripped-down indexOf if we can't use a native one - indexOf = arr.indexOf || function( elem ) { - var i = 0, - len = this.length; - for ( ; i < len; i++ ) { - if ( this[i] === elem ) { - return i; - } - } - return -1; - }, - - booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", - - // Regular expressions - - // Whitespace characters http://www.w3.org/TR/css3-selectors/#whitespace - whitespace = "[\\x20\\t\\r\\n\\f]", - // http://www.w3.org/TR/css3-syntax/#characters - characterEncoding = "(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+", - - // Loosely modeled on CSS identifier characters - // An unquoted value should be a CSS identifier http://www.w3.org/TR/css3-selectors/#attribute-selectors - // Proper syntax: http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier - identifier = characterEncoding.replace( "w", "w#" ), - - // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors - attributes = "\\[" + whitespace + "*(" + characterEncoding + ")(?:" + whitespace + - // Operator (capture 2) - "*([*^$|!~]?=)" + whitespace + - // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" - "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + - "*\\]", - - pseudos = ":(" + characterEncoding + ")(?:\\((" + - // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: - // 1. quoted (capture 3; capture 4 or capture 5) - "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + - // 2. simple (capture 6) - "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + - // 3. anything else (capture 2) - ".*" + - ")\\)|)", - - // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter - rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), - - rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), - rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), - - rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), - - rpseudo = new RegExp( pseudos ), - ridentifier = new RegExp( "^" + identifier + "$" ), - - matchExpr = { - "ID": new RegExp( "^#(" + characterEncoding + ")" ), - "CLASS": new RegExp( "^\\.(" + characterEncoding + ")" ), - "TAG": new RegExp( "^(" + characterEncoding.replace( "w", "w*" ) + ")" ), - "ATTR": new RegExp( "^" + attributes ), - "PSEUDO": new RegExp( "^" + pseudos ), - "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + - "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + - "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), - "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), - // For use in libraries implementing .is() - // We use this for POS matching in `select` - "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + - whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) - }, - - rinputs = /^(?:input|select|textarea|button)$/i, - rheader = /^h\d$/i, - - rnative = /^[^{]+\{\s*\[native \w/, - - // Easily-parseable/retrievable ID or TAG or CLASS selectors - rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, - - rsibling = /[+~]/, - rescape = /'|\\/g, - - // CSS escapes http://www.w3.org/TR/CSS21/syndata.html#escaped-characters - runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), - funescape = function( _, escaped, escapedWhitespace ) { - var high = "0x" + escaped - 0x10000; - // NaN means non-codepoint - // Support: Firefox<24 - // Workaround erroneous numeric interpretation of +"0x" - return high !== high || escapedWhitespace ? - escaped : - high < 0 ? - // BMP codepoint - String.fromCharCode( high + 0x10000 ) : - // Supplemental Plane codepoint (surrogate pair) - String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); - }; - -// Optimize for push.apply( _, NodeList ) -try { - push.apply( - (arr = slice.call( preferredDoc.childNodes )), - preferredDoc.childNodes - ); - // Support: Android<4.0 - // Detect silently failing push.apply - arr[ preferredDoc.childNodes.length ].nodeType; -} catch ( e ) { - push = { apply: arr.length ? - - // Leverage slice if possible - function( target, els ) { - push_native.apply( target, slice.call(els) ); - } : - - // Support: IE<9 - // Otherwise append directly - function( target, els ) { - var j = target.length, - i = 0; - // Can't trust NodeList.length - while ( (target[j++] = els[i++]) ) {} - target.length = j - 1; - } - }; -} - -function Sizzle( selector, context, results, seed ) { - var match, elem, m, nodeType, - // QSA vars - i, groups, old, nid, newContext, newSelector; - - if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { - setDocument( context ); - } - - context = context || document; - results = results || []; - - if ( !selector || typeof selector !== "string" ) { - return results; - } - - if ( (nodeType = context.nodeType) !== 1 && nodeType !== 9 ) { - return []; - } - - if ( documentIsHTML && !seed ) { - - // Shortcuts - if ( (match = rquickExpr.exec( selector )) ) { - // Speed-up: Sizzle("#ID") - if ( (m = match[1]) ) { - if ( nodeType === 9 ) { - elem = context.getElementById( m ); - // Check parentNode to catch when Blackberry 4.6 returns - // nodes that are no longer in the document (jQuery #6963) - if ( elem && elem.parentNode ) { - // Handle the case where IE, Opera, and Webkit return items - // by name instead of ID - if ( elem.id === m ) { - results.push( elem ); - return results; - } - } else { - return results; - } - } else { - // Context is not a document - if ( context.ownerDocument && (elem = context.ownerDocument.getElementById( m )) && - contains( context, elem ) && elem.id === m ) { - results.push( elem ); - return results; - } - } - - // Speed-up: Sizzle("TAG") - } else if ( match[2] ) { - push.apply( results, context.getElementsByTagName( selector ) ); - return results; - - // Speed-up: Sizzle(".CLASS") - } else if ( (m = match[3]) && support.getElementsByClassName && context.getElementsByClassName ) { - push.apply( results, context.getElementsByClassName( m ) ); - return results; - } - } - - // QSA path - if ( support.qsa && (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { - nid = old = expando; - newContext = context; - newSelector = nodeType === 9 && selector; - - // qSA works strangely on Element-rooted queries - // We can work around this by specifying an extra ID on the root - // and working up from there (Thanks to Andrew Dupont for the technique) - // IE 8 doesn't work on object elements - if ( nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) { - groups = tokenize( selector ); - - if ( (old = context.getAttribute("id")) ) { - nid = old.replace( rescape, "\\$&" ); - } else { - context.setAttribute( "id", nid ); - } - nid = "[id='" + nid + "'] "; - - i = groups.length; - while ( i-- ) { - groups[i] = nid + toSelector( groups[i] ); - } - newContext = rsibling.test( selector ) && testContext( context.parentNode ) || context; - newSelector = groups.join(","); - } - - if ( newSelector ) { - try { - push.apply( results, - newContext.querySelectorAll( newSelector ) - ); - return results; - } catch(qsaError) { - } finally { - if ( !old ) { - context.removeAttribute("id"); - } - } - } - } - } - - // All others - return select( selector.replace( rtrim, "$1" ), context, results, seed ); -} - -/** - * Create key-value caches of limited size - * @returns {Function(string, Object)} Returns the Object data after storing it on itself with - * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) - * deleting the oldest entry - */ -function createCache() { - var keys = []; - - function cache( key, value ) { - // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) - if ( keys.push( key + " " ) > Expr.cacheLength ) { - // Only keep the most recent entries - delete cache[ keys.shift() ]; - } - return (cache[ key + " " ] = value); - } - return cache; -} - -/** - * Mark a function for special use by Sizzle - * @param {Function} fn The function to mark - */ -function markFunction( fn ) { - fn[ expando ] = true; - return fn; -} - -/** - * Support testing using an element - * @param {Function} fn Passed the created div and expects a boolean result - */ -function assert( fn ) { - var div = document.createElement("div"); - - try { - return !!fn( div ); - } catch (e) { - return false; - } finally { - // Remove from its parent by default - if ( div.parentNode ) { - div.parentNode.removeChild( div ); - } - // release memory in IE - div = null; - } -} - -/** - * Adds the same handler for all of the specified attrs - * @param {String} attrs Pipe-separated list of attributes - * @param {Function} handler The method that will be applied - */ -function addHandle( attrs, handler ) { - var arr = attrs.split("|"), - i = attrs.length; - - while ( i-- ) { - Expr.attrHandle[ arr[i] ] = handler; - } -} - -/** - * Checks document order of two siblings - * @param {Element} a - * @param {Element} b - * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b - */ -function siblingCheck( a, b ) { - var cur = b && a, - diff = cur && a.nodeType === 1 && b.nodeType === 1 && - ( ~b.sourceIndex || MAX_NEGATIVE ) - - ( ~a.sourceIndex || MAX_NEGATIVE ); - - // Use IE sourceIndex if available on both nodes - if ( diff ) { - return diff; - } - - // Check if b follows a - if ( cur ) { - while ( (cur = cur.nextSibling) ) { - if ( cur === b ) { - return -1; - } - } - } - - return a ? 1 : -1; -} - -/** - * Returns a function to use in pseudos for input types - * @param {String} type - */ -function createInputPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for buttons - * @param {String} type - */ -function createButtonPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return (name === "input" || name === "button") && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for positionals - * @param {Function} fn - */ -function createPositionalPseudo( fn ) { - return markFunction(function( argument ) { - argument = +argument; - return markFunction(function( seed, matches ) { - var j, - matchIndexes = fn( [], seed.length, argument ), - i = matchIndexes.length; - - // Match elements found at the specified indexes - while ( i-- ) { - if ( seed[ (j = matchIndexes[i]) ] ) { - seed[j] = !(matches[j] = seed[j]); - } - } - }); - }); -} - -/** - * Checks a node for validity as a Sizzle context - * @param {Element|Object=} context - * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value - */ -function testContext( context ) { - return context && typeof context.getElementsByTagName !== strundefined && context; -} - -// Expose support vars for convenience -support = Sizzle.support = {}; - -/** - * Detects XML nodes - * @param {Element|Object} elem An element or a document - * @returns {Boolean} True iff elem is a non-HTML XML node - */ -isXML = Sizzle.isXML = function( elem ) { - // documentElement is verified for cases where it doesn't yet exist - // (such as loading iframes in IE - #4833) - var documentElement = elem && (elem.ownerDocument || elem).documentElement; - return documentElement ? documentElement.nodeName !== "HTML" : false; -}; - -/** - * Sets document-related variables once based on the current document - * @param {Element|Object} [doc] An element or document object to use to set the document - * @returns {Object} Returns the current document - */ -setDocument = Sizzle.setDocument = function( node ) { - var hasCompare, - doc = node ? node.ownerDocument || node : preferredDoc, - parent = doc.defaultView; - - // If no document and documentElement is available, return - if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { - return document; - } - - // Set our document - document = doc; - docElem = doc.documentElement; - - // Support tests - documentIsHTML = !isXML( doc ); - - // Support: IE>8 - // If iframe document is assigned to "document" variable and if iframe has been reloaded, - // IE will throw "permission denied" error when accessing "document" variable, see jQuery #13936 - // IE6-8 do not support the defaultView property so parent will be undefined - if ( parent && parent !== parent.top ) { - // IE11 does not have attachEvent, so all must suffer - if ( parent.addEventListener ) { - parent.addEventListener( "unload", function() { - setDocument(); - }, false ); - } else if ( parent.attachEvent ) { - parent.attachEvent( "onunload", function() { - setDocument(); - }); - } - } - - /* Attributes - ---------------------------------------------------------------------- */ - - // Support: IE<8 - // Verify that getAttribute really returns attributes and not properties (excepting IE8 booleans) - support.attributes = assert(function( div ) { - div.className = "i"; - return !div.getAttribute("className"); - }); - - /* getElement(s)By* - ---------------------------------------------------------------------- */ - - // Check if getElementsByTagName("*") returns only elements - support.getElementsByTagName = assert(function( div ) { - div.appendChild( doc.createComment("") ); - return !div.getElementsByTagName("*").length; - }); - - // Check if getElementsByClassName can be trusted - support.getElementsByClassName = rnative.test( doc.getElementsByClassName ) && assert(function( div ) { - div.innerHTML = "
"; - - // Support: Safari<4 - // Catch class over-caching - div.firstChild.className = "i"; - // Support: Opera<10 - // Catch gEBCN failure to find non-leading classes - return div.getElementsByClassName("i").length === 2; - }); - - // Support: IE<10 - // Check if getElementById returns elements by name - // The broken getElementById methods don't pick up programatically-set names, - // so use a roundabout getElementsByName test - support.getById = assert(function( div ) { - docElem.appendChild( div ).id = expando; - return !doc.getElementsByName || !doc.getElementsByName( expando ).length; - }); - - // ID find and filter - if ( support.getById ) { - Expr.find["ID"] = function( id, context ) { - if ( typeof context.getElementById !== strundefined && documentIsHTML ) { - var m = context.getElementById( id ); - // Check parentNode to catch when Blackberry 4.6 returns - // nodes that are no longer in the document #6963 - return m && m.parentNode ? [ m ] : []; - } - }; - Expr.filter["ID"] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - return elem.getAttribute("id") === attrId; - }; - }; - } else { - // Support: IE6/7 - // getElementById is not reliable as a find shortcut - delete Expr.find["ID"]; - - Expr.filter["ID"] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - var node = typeof elem.getAttributeNode !== strundefined && elem.getAttributeNode("id"); - return node && node.value === attrId; - }; - }; - } - - // Tag - Expr.find["TAG"] = support.getElementsByTagName ? - function( tag, context ) { - if ( typeof context.getElementsByTagName !== strundefined ) { - return context.getElementsByTagName( tag ); - } - } : - function( tag, context ) { - var elem, - tmp = [], - i = 0, - results = context.getElementsByTagName( tag ); - - // Filter out possible comments - if ( tag === "*" ) { - while ( (elem = results[i++]) ) { - if ( elem.nodeType === 1 ) { - tmp.push( elem ); - } - } - - return tmp; - } - return results; - }; - - // Class - Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { - if ( typeof context.getElementsByClassName !== strundefined && documentIsHTML ) { - return context.getElementsByClassName( className ); - } - }; - - /* QSA/matchesSelector - ---------------------------------------------------------------------- */ - - // QSA and matchesSelector support - - // matchesSelector(:active) reports false when true (IE9/Opera 11.5) - rbuggyMatches = []; - - // qSa(:focus) reports false when true (Chrome 21) - // We allow this because of a bug in IE8/9 that throws an error - // whenever `document.activeElement` is accessed on an iframe - // So, we allow :focus to pass through QSA all the time to avoid the IE error - // See http://bugs.jquery.com/ticket/13378 - rbuggyQSA = []; - - if ( (support.qsa = rnative.test( doc.querySelectorAll )) ) { - // Build QSA regex - // Regex strategy adopted from Diego Perini - assert(function( div ) { - // Select is set to empty string on purpose - // This is to test IE's treatment of not explicitly - // setting a boolean content attribute, - // since its presence should be enough - // http://bugs.jquery.com/ticket/12359 - div.innerHTML = ""; - - // Support: IE8, Opera 11-12.16 - // Nothing should be selected when empty strings follow ^= or $= or *= - // The test attribute must be unknown in Opera but "safe" for WinRT - // http://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section - if ( div.querySelectorAll("[msallowclip^='']").length ) { - rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); - } - - // Support: IE8 - // Boolean attributes and "value" are not treated correctly - if ( !div.querySelectorAll("[selected]").length ) { - rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); - } - - // Webkit/Opera - :checked should return selected option elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - // IE8 throws error here and will not see later tests - if ( !div.querySelectorAll(":checked").length ) { - rbuggyQSA.push(":checked"); - } - }); - - assert(function( div ) { - // Support: Windows 8 Native Apps - // The type and name attributes are restricted during .innerHTML assignment - var input = doc.createElement("input"); - input.setAttribute( "type", "hidden" ); - div.appendChild( input ).setAttribute( "name", "D" ); - - // Support: IE8 - // Enforce case-sensitivity of name attribute - if ( div.querySelectorAll("[name=d]").length ) { - rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); - } - - // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) - // IE8 throws error here and will not see later tests - if ( !div.querySelectorAll(":enabled").length ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Opera 10-11 does not throw on post-comma invalid pseudos - div.querySelectorAll("*,:x"); - rbuggyQSA.push(",.*:"); - }); - } - - if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || - docElem.webkitMatchesSelector || - docElem.mozMatchesSelector || - docElem.oMatchesSelector || - docElem.msMatchesSelector) )) ) { - - assert(function( div ) { - // Check to see if it's possible to do matchesSelector - // on a disconnected node (IE 9) - support.disconnectedMatch = matches.call( div, "div" ); - - // This should fail with an exception - // Gecko does not error, returns false instead - matches.call( div, "[s!='']:x" ); - rbuggyMatches.push( "!=", pseudos ); - }); - } - - rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); - rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); - - /* Contains - ---------------------------------------------------------------------- */ - hasCompare = rnative.test( docElem.compareDocumentPosition ); - - // Element contains another - // Purposefully does not implement inclusive descendent - // As in, an element does not contain itself - contains = hasCompare || rnative.test( docElem.contains ) ? - function( a, b ) { - 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; - }; - - /* Sorting - ---------------------------------------------------------------------- */ - - // Document order sorting - sortOrder = hasCompare ? - function( a, b ) { - - // Flag for duplicate removal - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - // Sort on method existence if only one input has compareDocumentPosition - var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; - if ( compare ) { - return compare; - } - - // Calculate position if both inputs belong to the same document - compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? - a.compareDocumentPosition( b ) : - - // Otherwise we know they are disconnected - 1; - - // Disconnected nodes - if ( compare & 1 || - (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { - - // Choose the first element that is related to our preferred document - if ( a === doc || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { - return -1; - } - if ( b === doc || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { - return 1; - } - - // Maintain original order - return sortInput ? - ( indexOf.call( sortInput, a ) - indexOf.call( sortInput, b ) ) : - 0; - } - - return compare & 4 ? -1 : 1; - } : - function( a, b ) { - // Exit early if the nodes are identical - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - var cur, - i = 0, - aup = a.parentNode, - bup = b.parentNode, - ap = [ a ], - bp = [ b ]; - - // Parentless nodes are either documents or disconnected - if ( !aup || !bup ) { - return a === doc ? -1 : - b === doc ? 1 : - aup ? -1 : - bup ? 1 : - sortInput ? - ( indexOf.call( sortInput, a ) - indexOf.call( sortInput, b ) ) : - 0; - - // If the nodes are siblings, we can do a quick check - } else if ( aup === bup ) { - return siblingCheck( a, b ); - } - - // Otherwise we need full lists of their ancestors for comparison - cur = a; - while ( (cur = cur.parentNode) ) { - ap.unshift( cur ); - } - cur = b; - while ( (cur = cur.parentNode) ) { - bp.unshift( cur ); - } - - // Walk down the tree looking for a discrepancy - while ( ap[i] === bp[i] ) { - i++; - } - - return i ? - // Do a sibling check if the nodes have a common ancestor - siblingCheck( ap[i], bp[i] ) : - - // Otherwise nodes in our document sort first - ap[i] === preferredDoc ? -1 : - bp[i] === preferredDoc ? 1 : - 0; - }; - - return doc; -}; - -Sizzle.matches = function( expr, elements ) { - return Sizzle( expr, null, null, elements ); -}; - -Sizzle.matchesSelector = function( elem, expr ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - // Make sure that attribute selectors are quoted - expr = expr.replace( rattributeQuotes, "='$1']" ); - - if ( support.matchesSelector && documentIsHTML && - ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && - ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { - - try { - var ret = matches.call( elem, expr ); - - // IE 9's matchesSelector returns false on disconnected nodes - if ( ret || support.disconnectedMatch || - // As well, disconnected nodes are said to be in a document - // fragment in IE 9 - elem.document && elem.document.nodeType !== 11 ) { - return ret; - } - } catch(e) {} - } - - return Sizzle( expr, document, null, [ elem ] ).length > 0; -}; - -Sizzle.contains = function( context, elem ) { - // Set document vars if needed - if ( ( context.ownerDocument || context ) !== document ) { - setDocument( context ); - } - return contains( context, elem ); -}; - -Sizzle.attr = function( elem, name ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - var fn = Expr.attrHandle[ name.toLowerCase() ], - // Don't get fooled by Object.prototype properties (jQuery #13807) - val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? - fn( elem, name, !documentIsHTML ) : - undefined; - - return val !== undefined ? - val : - support.attributes || !documentIsHTML ? - elem.getAttribute( name ) : - (val = elem.getAttributeNode(name)) && val.specified ? - val.value : - null; -}; - -Sizzle.error = function( msg ) { - throw new Error( "Syntax error, unrecognized expression: " + msg ); -}; - -/** - * Document sorting and removing duplicates - * @param {ArrayLike} results - */ -Sizzle.uniqueSort = function( results ) { - var elem, - duplicates = [], - j = 0, - i = 0; - - // Unless we *know* we can detect duplicates, assume their presence - hasDuplicate = !support.detectDuplicates; - sortInput = !support.sortStable && results.slice( 0 ); - results.sort( sortOrder ); - - if ( hasDuplicate ) { - while ( (elem = results[i++]) ) { - if ( elem === results[ i ] ) { - j = duplicates.push( i ); - } - } - while ( j-- ) { - results.splice( duplicates[ j ], 1 ); - } - } - - // Clear input after sorting to release objects - // See https://github.com/jquery/sizzle/pull/225 - sortInput = null; - - return results; -}; - -/** - * Utility function for retrieving the text value of an array of DOM nodes - * @param {Array|Element} elem - */ -getText = Sizzle.getText = function( elem ) { - var node, - ret = "", - i = 0, - nodeType = elem.nodeType; - - if ( !nodeType ) { - // If no nodeType, this is expected to be an array - while ( (node = elem[i++]) ) { - // Do not traverse comment nodes - ret += getText( node ); - } - } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { - // Use textContent for elements - // innerText usage removed for consistency of new lines (jQuery #11153) - if ( typeof elem.textContent === "string" ) { - return elem.textContent; - } else { - // Traverse its children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - ret += getText( elem ); - } - } - } else if ( nodeType === 3 || nodeType === 4 ) { - return elem.nodeValue; - } - // Do not include comment or processing instruction nodes - - return ret; -}; - -Expr = Sizzle.selectors = { - - // Can be adjusted by the user - cacheLength: 50, - - createPseudo: markFunction, - - match: matchExpr, - - attrHandle: {}, - - find: {}, - - relative: { - ">": { dir: "parentNode", first: true }, - " ": { dir: "parentNode" }, - "+": { dir: "previousSibling", first: true }, - "~": { dir: "previousSibling" } - }, - - preFilter: { - "ATTR": function( match ) { - match[1] = match[1].replace( runescape, funescape ); - - // Move the given value to match[3] whether quoted or unquoted - match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); - - if ( match[2] === "~=" ) { - match[3] = " " + match[3] + " "; - } - - return match.slice( 0, 4 ); - }, - - "CHILD": function( match ) { - /* matches from matchExpr["CHILD"] - 1 type (only|nth|...) - 2 what (child|of-type) - 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) - 4 xn-component of xn+y argument ([+-]?\d*n|) - 5 sign of xn-component - 6 x of xn-component - 7 sign of y-component - 8 y of y-component - */ - match[1] = match[1].toLowerCase(); - - if ( match[1].slice( 0, 3 ) === "nth" ) { - // nth-* requires argument - if ( !match[3] ) { - Sizzle.error( match[0] ); - } - - // numeric x and y parameters for Expr.filter.CHILD - // remember that false/true cast respectively to 0/1 - match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); - match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); - - // other types prohibit arguments - } else if ( match[3] ) { - Sizzle.error( match[0] ); - } - - return match; - }, - - "PSEUDO": function( match ) { - var excess, - unquoted = !match[6] && match[2]; - - if ( matchExpr["CHILD"].test( match[0] ) ) { - return null; - } - - // Accept quoted arguments as-is - if ( match[3] ) { - match[2] = match[4] || match[5] || ""; - - // Strip excess characters from unquoted arguments - } else if ( unquoted && rpseudo.test( unquoted ) && - // Get excess from tokenize (recursively) - (excess = tokenize( unquoted, true )) && - // advance to the next closing parenthesis - (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { - - // excess is a negative index - match[0] = match[0].slice( 0, excess ); - match[2] = unquoted.slice( 0, excess ); - } - - // Return only captures needed by the pseudo filter method (type and argument) - return match.slice( 0, 3 ); - } - }, - - filter: { - - "TAG": function( nodeNameSelector ) { - var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); - return nodeNameSelector === "*" ? - function() { return true; } : - function( elem ) { - return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; - }; - }, - - "CLASS": function( className ) { - var pattern = classCache[ className + " " ]; - - return pattern || - (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && - classCache( className, function( elem ) { - return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== strundefined && elem.getAttribute("class") || "" ); - }); - }, - - "ATTR": function( name, operator, check ) { - return function( elem ) { - var result = Sizzle.attr( elem, name ); - - if ( result == null ) { - return operator === "!="; - } - if ( !operator ) { - return true; - } - - result += ""; - - return operator === "=" ? result === check : - operator === "!=" ? result !== check : - operator === "^=" ? check && result.indexOf( check ) === 0 : - operator === "*=" ? check && result.indexOf( check ) > -1 : - operator === "$=" ? check && result.slice( -check.length ) === check : - operator === "~=" ? ( " " + result + " " ).indexOf( check ) > -1 : - operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : - false; - }; - }, - - "CHILD": function( type, what, argument, first, last ) { - var simple = type.slice( 0, 3 ) !== "nth", - forward = type.slice( -4 ) !== "last", - ofType = what === "of-type"; - - return first === 1 && last === 0 ? - - // Shortcut for :nth-*(n) - function( elem ) { - return !!elem.parentNode; - } : - - function( elem, context, xml ) { - var cache, outerCache, node, diff, nodeIndex, start, - dir = simple !== forward ? "nextSibling" : "previousSibling", - parent = elem.parentNode, - name = ofType && elem.nodeName.toLowerCase(), - useCache = !xml && !ofType; - - if ( parent ) { - - // :(first|last|only)-(child|of-type) - if ( simple ) { - while ( dir ) { - node = elem; - while ( (node = node[ dir ]) ) { - if ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) { - return false; - } - } - // Reverse direction for :only-* (if we haven't yet done so) - start = dir = type === "only" && !start && "nextSibling"; - } - return true; - } - - start = [ forward ? parent.firstChild : parent.lastChild ]; - - // non-xml :nth-child(...) stores cache data on `parent` - if ( forward && useCache ) { - // Seek `elem` from a previously-cached index - outerCache = parent[ expando ] || (parent[ expando ] = {}); - cache = outerCache[ type ] || []; - nodeIndex = cache[0] === dirruns && cache[1]; - diff = cache[0] === dirruns && cache[2]; - node = nodeIndex && parent.childNodes[ nodeIndex ]; - - while ( (node = ++nodeIndex && node && node[ dir ] || - - // Fallback to seeking `elem` from the start - (diff = nodeIndex = 0) || start.pop()) ) { - - // When found, cache indexes on `parent` and break - if ( node.nodeType === 1 && ++diff && node === elem ) { - outerCache[ type ] = [ dirruns, nodeIndex, diff ]; - break; - } - } - - // Use previously-cached element index if available - } else if ( useCache && (cache = (elem[ expando ] || (elem[ expando ] = {}))[ type ]) && cache[0] === dirruns ) { - diff = cache[1]; - - // xml :nth-child(...) or :nth-last-child(...) or :nth(-last)?-of-type(...) - } else { - // Use the same loop as above to seek `elem` from the start - while ( (node = ++nodeIndex && node && node[ dir ] || - (diff = nodeIndex = 0) || start.pop()) ) { - - if ( ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) && ++diff ) { - // Cache the index of each encountered element - if ( useCache ) { - (node[ expando ] || (node[ expando ] = {}))[ type ] = [ dirruns, diff ]; - } - - if ( node === elem ) { - break; - } - } - } - } - - // Incorporate the offset, then check against cycle size - diff -= last; - return diff === first || ( diff % first === 0 && diff / first >= 0 ); - } - }; - }, - - "PSEUDO": function( pseudo, argument ) { - // pseudo-class names are case-insensitive - // http://www.w3.org/TR/selectors/#pseudo-classes - // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters - // Remember that setFilters inherits from pseudos - var args, - fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || - Sizzle.error( "unsupported pseudo: " + pseudo ); - - // The user may use createPseudo to indicate that - // arguments are needed to create the filter function - // just as Sizzle does - if ( fn[ expando ] ) { - return fn( argument ); - } - - // But maintain support for old signatures - if ( fn.length > 1 ) { - args = [ pseudo, pseudo, "", argument ]; - return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? - markFunction(function( seed, matches ) { - var idx, - matched = fn( seed, argument ), - i = matched.length; - while ( i-- ) { - idx = indexOf.call( seed, matched[i] ); - seed[ idx ] = !( matches[ idx ] = matched[i] ); - } - }) : - function( elem ) { - return fn( elem, 0, args ); - }; - } - - return fn; - } - }, - - pseudos: { - // Potentially complex pseudos - "not": markFunction(function( selector ) { - // Trim the selector passed to compile - // to avoid treating leading and trailing - // spaces as combinators - var input = [], - results = [], - matcher = compile( selector.replace( rtrim, "$1" ) ); - - return matcher[ expando ] ? - markFunction(function( seed, matches, context, xml ) { - var elem, - unmatched = matcher( seed, null, xml, [] ), - i = seed.length; - - // Match elements unmatched by `matcher` - while ( i-- ) { - if ( (elem = unmatched[i]) ) { - seed[i] = !(matches[i] = elem); - } - } - }) : - function( elem, context, xml ) { - input[0] = elem; - matcher( input, null, xml, results ); - return !results.pop(); - }; - }), - - "has": markFunction(function( selector ) { - return function( elem ) { - return Sizzle( selector, elem ).length > 0; - }; - }), - - "contains": markFunction(function( text ) { - return function( elem ) { - return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; - }; - }), - - // "Whether an element is represented by a :lang() selector - // is based solely on the element's language value - // being equal to the identifier C, - // or beginning with the identifier C immediately followed by "-". - // The matching of C against the element's language value is performed case-insensitively. - // The identifier C does not have to be a valid language name." - // http://www.w3.org/TR/selectors/#lang-pseudo - "lang": markFunction( function( lang ) { - // lang value must be a valid identifier - if ( !ridentifier.test(lang || "") ) { - Sizzle.error( "unsupported lang: " + lang ); - } - lang = lang.replace( runescape, funescape ).toLowerCase(); - return function( elem ) { - var elemLang; - do { - if ( (elemLang = documentIsHTML ? - elem.lang : - elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { - - elemLang = elemLang.toLowerCase(); - return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; - } - } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); - return false; - }; - }), - - // Miscellaneous - "target": function( elem ) { - var hash = window.location && window.location.hash; - return hash && hash.slice( 1 ) === elem.id; - }, - - "root": function( elem ) { - return elem === docElem; - }, - - "focus": function( elem ) { - return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); - }, - - // Boolean properties - "enabled": function( elem ) { - return elem.disabled === false; - }, - - "disabled": function( elem ) { - return elem.disabled === true; - }, - - "checked": function( elem ) { - // In CSS3, :checked should return both checked and selected elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - var nodeName = elem.nodeName.toLowerCase(); - return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); - }, - - "selected": function( elem ) { - // Accessing this property makes selected-by-default - // options in Safari work properly - if ( elem.parentNode ) { - elem.parentNode.selectedIndex; - } - - return elem.selected === true; - }, - - // Contents - "empty": function( elem ) { - // http://www.w3.org/TR/selectors/#empty-pseudo - // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), - // but not by others (comment: 8; processing instruction: 7; etc.) - // nodeType < 6 works because attributes (2) do not appear as children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - if ( elem.nodeType < 6 ) { - return false; - } - } - return true; - }, - - "parent": function( elem ) { - return !Expr.pseudos["empty"]( elem ); - }, - - // Element/input types - "header": function( elem ) { - return rheader.test( elem.nodeName ); - }, - - "input": function( elem ) { - return rinputs.test( elem.nodeName ); - }, - - "button": function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === "button" || name === "button"; - }, - - "text": function( elem ) { - var attr; - return elem.nodeName.toLowerCase() === "input" && - elem.type === "text" && - - // Support: IE<8 - // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" - ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); - }, - - // Position-in-collection - "first": createPositionalPseudo(function() { - return [ 0 ]; - }), - - "last": createPositionalPseudo(function( matchIndexes, length ) { - return [ length - 1 ]; - }), - - "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { - return [ argument < 0 ? argument + length : argument ]; - }), - - "even": createPositionalPseudo(function( matchIndexes, length ) { - var i = 0; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "odd": createPositionalPseudo(function( matchIndexes, length ) { - var i = 1; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; - for ( ; --i >= 0; ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; - for ( ; ++i < length; ) { - matchIndexes.push( i ); - } - return matchIndexes; - }) - } -}; - -Expr.pseudos["nth"] = Expr.pseudos["eq"]; - -// Add button/input type pseudos -for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { - Expr.pseudos[ i ] = createInputPseudo( i ); -} -for ( i in { submit: true, reset: true } ) { - Expr.pseudos[ i ] = createButtonPseudo( i ); -} - -// Easy API for creating new setFilters -function setFilters() {} -setFilters.prototype = Expr.filters = Expr.pseudos; -Expr.setFilters = new setFilters(); - -tokenize = Sizzle.tokenize = function( selector, parseOnly ) { - var matched, match, tokens, type, - soFar, groups, preFilters, - cached = tokenCache[ selector + " " ]; - - if ( cached ) { - return parseOnly ? 0 : cached.slice( 0 ); - } - - soFar = selector; - groups = []; - preFilters = Expr.preFilter; - - while ( soFar ) { - - // Comma and first run - if ( !matched || (match = rcomma.exec( soFar )) ) { - if ( match ) { - // Don't consume trailing commas as valid - soFar = soFar.slice( match[0].length ) || soFar; - } - groups.push( (tokens = []) ); - } - - matched = false; - - // Combinators - if ( (match = rcombinators.exec( soFar )) ) { - matched = match.shift(); - tokens.push({ - value: matched, - // Cast descendant combinators to space - type: match[0].replace( rtrim, " " ) - }); - soFar = soFar.slice( matched.length ); - } - - // Filters - for ( type in Expr.filter ) { - if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || - (match = preFilters[ type ]( match ))) ) { - matched = match.shift(); - tokens.push({ - value: matched, - type: type, - matches: match - }); - soFar = soFar.slice( matched.length ); - } - } - - if ( !matched ) { - break; - } - } - - // Return the length of the invalid excess - // if we're just parsing - // Otherwise, throw an error or return tokens - return parseOnly ? - soFar.length : - soFar ? - Sizzle.error( selector ) : - // Cache the tokens - tokenCache( selector, groups ).slice( 0 ); -}; - -function toSelector( tokens ) { - var i = 0, - len = tokens.length, - selector = ""; - for ( ; i < len; i++ ) { - selector += tokens[i].value; - } - return selector; -} - -function addCombinator( matcher, combinator, base ) { - var dir = combinator.dir, - checkNonElements = base && dir === "parentNode", - doneName = done++; - - return combinator.first ? - // Check against closest ancestor/preceding element - function( elem, context, xml ) { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - return matcher( elem, context, xml ); - } - } - } : - - // Check against all ancestor/preceding elements - function( elem, context, xml ) { - var oldCache, outerCache, - newCache = [ dirruns, doneName ]; - - // We can't set arbitrary data on XML nodes, so they don't benefit from dir caching - if ( xml ) { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - if ( matcher( elem, context, xml ) ) { - return true; - } - } - } - } else { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - outerCache = elem[ expando ] || (elem[ expando ] = {}); - if ( (oldCache = outerCache[ dir ]) && - oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { - - // Assign to newCache so results back-propagate to previous elements - return (newCache[ 2 ] = oldCache[ 2 ]); - } else { - // Reuse newcache so results back-propagate to previous elements - outerCache[ dir ] = newCache; - - // A match means we're done; a fail means we have to keep checking - if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { - return true; - } - } - } - } - } - }; -} - -function elementMatcher( matchers ) { - return matchers.length > 1 ? - function( elem, context, xml ) { - var i = matchers.length; - while ( i-- ) { - if ( !matchers[i]( elem, context, xml ) ) { - return false; - } - } - return true; - } : - matchers[0]; -} - -function multipleContexts( selector, contexts, results ) { - var i = 0, - len = contexts.length; - for ( ; i < len; i++ ) { - Sizzle( selector, contexts[i], results ); - } - return results; -} - -function condense( unmatched, map, filter, context, xml ) { - var elem, - newUnmatched = [], - i = 0, - len = unmatched.length, - mapped = map != null; - - for ( ; i < len; i++ ) { - if ( (elem = unmatched[i]) ) { - if ( !filter || filter( elem, context, xml ) ) { - newUnmatched.push( elem ); - if ( mapped ) { - map.push( i ); - } - } - } - } - - return newUnmatched; -} - -function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { - if ( postFilter && !postFilter[ expando ] ) { - postFilter = setMatcher( postFilter ); - } - if ( postFinder && !postFinder[ expando ] ) { - postFinder = setMatcher( postFinder, postSelector ); - } - return markFunction(function( seed, results, context, xml ) { - var temp, i, elem, - preMap = [], - postMap = [], - preexisting = results.length, - - // Get initial elements from seed or context - elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), - - // Prefilter to get matcher input, preserving a map for seed-results synchronization - matcherIn = preFilter && ( seed || !selector ) ? - condense( elems, preMap, preFilter, context, xml ) : - elems, - - matcherOut = matcher ? - // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, - postFinder || ( seed ? preFilter : preexisting || postFilter ) ? - - // ...intermediate processing is necessary - [] : - - // ...otherwise use results directly - results : - matcherIn; - - // Find primary matches - if ( matcher ) { - matcher( matcherIn, matcherOut, context, xml ); - } - - // Apply postFilter - if ( postFilter ) { - temp = condense( matcherOut, postMap ); - postFilter( temp, [], context, xml ); - - // Un-match failing elements by moving them back to matcherIn - i = temp.length; - while ( i-- ) { - if ( (elem = temp[i]) ) { - matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); - } - } - } - - if ( seed ) { - if ( postFinder || preFilter ) { - if ( postFinder ) { - // Get the final matcherOut by condensing this intermediate into postFinder contexts - temp = []; - i = matcherOut.length; - while ( i-- ) { - if ( (elem = matcherOut[i]) ) { - // Restore matcherIn since elem is not yet a final match - temp.push( (matcherIn[i] = elem) ); - } - } - postFinder( null, (matcherOut = []), temp, xml ); - } - - // Move matched elements from seed to results to keep them synchronized - i = matcherOut.length; - while ( i-- ) { - if ( (elem = matcherOut[i]) && - (temp = postFinder ? indexOf.call( seed, elem ) : preMap[i]) > -1 ) { - - seed[temp] = !(results[temp] = elem); - } - } - } - - // Add elements to results, through postFinder if defined - } else { - matcherOut = condense( - matcherOut === results ? - matcherOut.splice( preexisting, matcherOut.length ) : - matcherOut - ); - if ( postFinder ) { - postFinder( null, results, matcherOut, xml ); - } else { - push.apply( results, matcherOut ); - } - } - }); -} - -function matcherFromTokens( tokens ) { - var checkContext, matcher, j, - len = tokens.length, - leadingRelative = Expr.relative[ tokens[0].type ], - implicitRelative = leadingRelative || Expr.relative[" "], - i = leadingRelative ? 1 : 0, - - // The foundational matcher ensures that elements are reachable from top-level context(s) - matchContext = addCombinator( function( elem ) { - return elem === checkContext; - }, implicitRelative, true ), - matchAnyContext = addCombinator( function( elem ) { - return indexOf.call( checkContext, elem ) > -1; - }, implicitRelative, true ), - matchers = [ function( elem, context, xml ) { - return ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( - (checkContext = context).nodeType ? - matchContext( elem, context, xml ) : - matchAnyContext( elem, context, xml ) ); - } ]; - - for ( ; i < len; i++ ) { - if ( (matcher = Expr.relative[ tokens[i].type ]) ) { - matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; - } else { - matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); - - // Return special upon seeing a positional matcher - if ( matcher[ expando ] ) { - // Find the next relative operator (if any) for proper handling - j = ++i; - for ( ; j < len; j++ ) { - if ( Expr.relative[ tokens[j].type ] ) { - break; - } - } - return setMatcher( - i > 1 && elementMatcher( matchers ), - i > 1 && toSelector( - // If the preceding token was a descendant combinator, insert an implicit any-element `*` - tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) - ).replace( rtrim, "$1" ), - matcher, - i < j && matcherFromTokens( tokens.slice( i, j ) ), - j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), - j < len && toSelector( tokens ) - ); - } - matchers.push( matcher ); - } - } - - return elementMatcher( matchers ); -} - -function matcherFromGroupMatchers( elementMatchers, setMatchers ) { - var bySet = setMatchers.length > 0, - byElement = elementMatchers.length > 0, - superMatcher = function( seed, context, xml, results, outermost ) { - var elem, j, matcher, - matchedCount = 0, - i = "0", - unmatched = seed && [], - setMatched = [], - contextBackup = outermostContext, - // We must always have either seed elements or outermost context - elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), - // Use integer dirruns iff this is the outermost matcher - dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), - len = elems.length; - - if ( outermost ) { - outermostContext = context !== document && context; - } - - // Add elements passing elementMatchers directly to results - // Keep `i` a string if there are no elements so `matchedCount` will be "00" below - // Support: IE<9, Safari - // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id - for ( ; i !== len && (elem = elems[i]) != null; i++ ) { - if ( byElement && elem ) { - j = 0; - while ( (matcher = elementMatchers[j++]) ) { - if ( matcher( elem, context, xml ) ) { - results.push( elem ); - break; - } - } - if ( outermost ) { - dirruns = dirrunsUnique; - } - } - - // Track unmatched elements for set filters - if ( bySet ) { - // They will have gone through all possible matchers - if ( (elem = !matcher && elem) ) { - matchedCount--; - } - - // Lengthen the array for every element, matched or not - if ( seed ) { - unmatched.push( elem ); - } - } - } - - // Apply set filters to unmatched elements - matchedCount += i; - if ( bySet && i !== matchedCount ) { - j = 0; - while ( (matcher = setMatchers[j++]) ) { - matcher( unmatched, setMatched, context, xml ); - } - - if ( seed ) { - // Reintegrate element matches to eliminate the need for sorting - if ( matchedCount > 0 ) { - while ( i-- ) { - if ( !(unmatched[i] || setMatched[i]) ) { - setMatched[i] = pop.call( results ); - } - } - } - - // Discard index placeholder values to get only actual matches - setMatched = condense( setMatched ); - } - - // Add matches to results - push.apply( results, setMatched ); - - // Seedless set matches succeeding multiple successful matchers stipulate sorting - if ( outermost && !seed && setMatched.length > 0 && - ( matchedCount + setMatchers.length ) > 1 ) { - - Sizzle.uniqueSort( results ); - } - } - - // Override manipulation of globals by nested matchers - if ( outermost ) { - dirruns = dirrunsUnique; - outermostContext = contextBackup; - } - - return unmatched; - }; - - return bySet ? - markFunction( superMatcher ) : - superMatcher; -} - -compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { - var i, - setMatchers = [], - elementMatchers = [], - cached = compilerCache[ selector + " " ]; - - if ( !cached ) { - // Generate a function of recursive functions that can be used to check each element - if ( !match ) { - match = tokenize( selector ); - } - i = match.length; - while ( i-- ) { - cached = matcherFromTokens( match[i] ); - if ( cached[ expando ] ) { - setMatchers.push( cached ); - } else { - elementMatchers.push( cached ); - } - } - - // Cache the compiled function - cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); - - // Save selector and tokenization - cached.selector = selector; - } - return cached; -}; - -/** - * A low-level selection function that works with Sizzle's compiled - * selector functions - * @param {String|Function} selector A selector or a pre-compiled - * selector function built with Sizzle.compile - * @param {Element} context - * @param {Array} [results] - * @param {Array} [seed] A set of elements to match against - */ -select = Sizzle.select = function( selector, context, results, seed ) { - var i, tokens, token, type, find, - compiled = typeof selector === "function" && selector, - match = !seed && tokenize( (selector = compiled.selector || selector) ); - - results = results || []; - - // Try to minimize operations if there is no seed and only one group - if ( match.length === 1 ) { - - // Take a shortcut and set the context if the root selector is an ID - tokens = match[0] = match[0].slice( 0 ); - if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && - support.getById && context.nodeType === 9 && documentIsHTML && - Expr.relative[ tokens[1].type ] ) { - - context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; - if ( !context ) { - return results; - - // Precompiled matchers will still verify ancestry, so step up a level - } else if ( compiled ) { - context = context.parentNode; - } - - selector = selector.slice( tokens.shift().value.length ); - } - - // Fetch a seed set for right-to-left matching - i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; - while ( i-- ) { - token = tokens[i]; - - // Abort if we hit a combinator - if ( Expr.relative[ (type = token.type) ] ) { - break; - } - if ( (find = Expr.find[ type ]) ) { - // Search, expanding context for leading sibling combinators - if ( (seed = find( - token.matches[0].replace( runescape, funescape ), - rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context - )) ) { - - // If seed is empty or no tokens remain, we can return early - tokens.splice( i, 1 ); - selector = seed.length && toSelector( tokens ); - if ( !selector ) { - push.apply( results, seed ); - return results; - } - - break; - } - } - } - } - - // Compile and execute a filtering function if one is not provided - // Provide `match` to avoid retokenization if we modified the selector above - ( compiled || compile( selector, match ) )( - seed, - context, - !documentIsHTML, - results, - rsibling.test( selector ) && testContext( context.parentNode ) || context - ); - return results; -}; - -// One-time assignments - -// Sort stability -support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; - -// Support: Chrome<14 -// Always assume duplicates if they aren't passed to the comparison function -support.detectDuplicates = !!hasDuplicate; - -// Initialize against the default document -setDocument(); - -// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) -// Detached nodes confoundingly follow *each other* -support.sortDetached = assert(function( div1 ) { - // Should return 1, but returns 4 (following) - return div1.compareDocumentPosition( document.createElement("div") ) & 1; -}); - -// Support: IE<8 -// Prevent attribute/property "interpolation" -// http://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx -if ( !assert(function( div ) { - div.innerHTML = ""; - return div.firstChild.getAttribute("href") === "#" ; -}) ) { - addHandle( "type|href|height|width", function( elem, name, isXML ) { - if ( !isXML ) { - return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); - } - }); -} - -// Support: IE<9 -// Use defaultValue in place of getAttribute("value") -if ( !support.attributes || !assert(function( div ) { - div.innerHTML = ""; - div.firstChild.setAttribute( "value", "" ); - return div.firstChild.getAttribute( "value" ) === ""; -}) ) { - addHandle( "value", function( elem, name, isXML ) { - if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { - return elem.defaultValue; - } - }); -} - -// Support: IE<9 -// Use getAttributeNode to fetch booleans when getAttribute lies -if ( !assert(function( div ) { - return div.getAttribute("disabled") == null; -}) ) { - addHandle( booleans, function( elem, name, isXML ) { - var val; - if ( !isXML ) { - return elem[ name ] === true ? name.toLowerCase() : - (val = elem.getAttributeNode( name )) && val.specified ? - val.value : - null; - } - }); -} - -return Sizzle; - -})( window ); - - - -jQuery.find = Sizzle; -jQuery.expr = Sizzle.selectors; -jQuery.expr[":"] = jQuery.expr.pseudos; -jQuery.unique = Sizzle.uniqueSort; -jQuery.text = Sizzle.getText; -jQuery.isXMLDoc = Sizzle.isXML; -jQuery.contains = Sizzle.contains; - - - -var rneedsContext = jQuery.expr.match.needsContext; - -var rsingleTag = (/^<(\w+)\s*\/?>(?:<\/\1>|)$/); - - - -var risSimple = /^.[^:#\[\.,]*$/; - -// Implement the identical functionality for filter and not -function winnow( elements, qualifier, not ) { - if ( jQuery.isFunction( qualifier ) ) { - return jQuery.grep( elements, function( elem, i ) { - /* jshint -W018 */ - return !!qualifier.call( elem, i, elem ) !== not; - }); - - } - - if ( qualifier.nodeType ) { - return jQuery.grep( elements, function( elem ) { - return ( elem === qualifier ) !== not; - }); - - } - - if ( typeof qualifier === "string" ) { - if ( risSimple.test( qualifier ) ) { - return jQuery.filter( qualifier, elements, not ); - } - - qualifier = jQuery.filter( qualifier, elements ); - } - - return jQuery.grep( elements, function( elem ) { - return ( indexOf.call( qualifier, elem ) >= 0 ) !== not; - }); -} - -jQuery.filter = function( expr, elems, not ) { - var elem = elems[ 0 ]; - - if ( not ) { - expr = ":not(" + expr + ")"; - } - - return elems.length === 1 && elem.nodeType === 1 ? - jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [] : - jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { - return elem.nodeType === 1; - })); -}; - -jQuery.fn.extend({ - find: function( selector ) { - var i, - len = this.length, - ret = [], - self = this; - - if ( typeof selector !== "string" ) { - return this.pushStack( jQuery( selector ).filter(function() { - for ( i = 0; i < len; i++ ) { - if ( jQuery.contains( self[ i ], this ) ) { - return true; - } - } - }) ); - } - - for ( i = 0; i < len; i++ ) { - jQuery.find( selector, self[ i ], ret ); - } - - // Needed because $( selector, context ) becomes $( context ).find( selector ) - ret = this.pushStack( len > 1 ? jQuery.unique( ret ) : ret ); - ret.selector = this.selector ? this.selector + " " + selector : selector; - return ret; - }, - filter: function( selector ) { - return this.pushStack( winnow(this, selector || [], false) ); - }, - not: function( selector ) { - return this.pushStack( winnow(this, selector || [], true) ); - }, - is: function( selector ) { - return !!winnow( - this, - - // If this is a positional/relative selector, check membership in the returned set - // so $("p:first").is("p:last") won't return true for a doc with two "p". - typeof selector === "string" && rneedsContext.test( selector ) ? - jQuery( selector ) : - selector || [], - false - ).length; - } -}); - - -// Initialize a jQuery object - - -// A central reference to the root jQuery(document) -var rootjQuery, - - // A simple way to check for HTML strings - // Prioritize #id over to avoid XSS via location.hash (#9521) - // Strict HTML recognition (#11290: must start with <) - rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/, - - init = jQuery.fn.init = function( selector, context ) { - var match, elem; - - // HANDLE: $(""), $(null), $(undefined), $(false) - if ( !selector ) { - return this; - } - - // Handle HTML strings - if ( typeof selector === "string" ) { - if ( selector[0] === "<" && selector[ selector.length - 1 ] === ">" && selector.length >= 3 ) { - // Assume that strings that start and end with <> are HTML and skip the regex check - match = [ null, selector, null ]; - - } else { - match = rquickExpr.exec( selector ); - } - - // Match html or make sure no context is specified for #id - if ( match && (match[1] || !context) ) { - - // HANDLE: $(html) -> $(array) - if ( match[1] ) { - context = context instanceof jQuery ? context[0] : context; - - // scripts is true for back-compat - // Intentionally let the error be thrown if parseHTML is not present - jQuery.merge( this, jQuery.parseHTML( - match[1], - context && context.nodeType ? context.ownerDocument || context : document, - true - ) ); - - // HANDLE: $(html, props) - if ( rsingleTag.test( match[1] ) && jQuery.isPlainObject( context ) ) { - for ( match in context ) { - // Properties of context are called as methods if possible - if ( jQuery.isFunction( this[ match ] ) ) { - this[ match ]( context[ match ] ); - - // ...and otherwise set as attributes - } else { - this.attr( match, context[ match ] ); - } - } - } - - return this; - - // HANDLE: $(#id) - } else { - elem = document.getElementById( match[2] ); - - // Check parentNode to catch when Blackberry 4.6 returns - // nodes that are no longer in the document #6963 - if ( elem && elem.parentNode ) { - // Inject the element directly into the jQuery object - this.length = 1; - this[0] = elem; - } - - this.context = document; - this.selector = selector; - return this; - } - - // HANDLE: $(expr, $(...)) - } else if ( !context || context.jquery ) { - return ( context || rootjQuery ).find( selector ); - - // HANDLE: $(expr, context) - // (which is just equivalent to: $(context).find(expr) - } else { - return this.constructor( context ).find( selector ); - } - - // HANDLE: $(DOMElement) - } else if ( selector.nodeType ) { - this.context = this[0] = selector; - this.length = 1; - return this; - - // HANDLE: $(function) - // Shortcut for document ready - } else if ( jQuery.isFunction( selector ) ) { - return typeof rootjQuery.ready !== "undefined" ? - rootjQuery.ready( selector ) : - // Execute immediately if ready is not present - selector( jQuery ); - } - - if ( selector.selector !== undefined ) { - this.selector = selector.selector; - this.context = selector.context; - } - - return jQuery.makeArray( selector, this ); - }; - -// Give the init function the jQuery prototype for later instantiation -init.prototype = jQuery.fn; - -// Initialize central reference -rootjQuery = jQuery( document ); - - -var rparentsprev = /^(?:parents|prev(?:Until|All))/, - // methods guaranteed to produce a unique set when starting from a unique set - guaranteedUnique = { - children: true, - contents: true, - next: true, - prev: true - }; - -jQuery.extend({ - dir: function( elem, dir, until ) { - var matched = [], - truncate = until !== undefined; - - while ( (elem = elem[ dir ]) && elem.nodeType !== 9 ) { - if ( elem.nodeType === 1 ) { - if ( truncate && jQuery( elem ).is( until ) ) { - break; - } - matched.push( elem ); - } - } - return matched; - }, - - sibling: function( n, elem ) { - var matched = []; - - for ( ; n; n = n.nextSibling ) { - if ( n.nodeType === 1 && n !== elem ) { - matched.push( n ); - } - } - - return matched; - } -}); - -jQuery.fn.extend({ - has: function( target ) { - var targets = jQuery( target, this ), - l = targets.length; - - return this.filter(function() { - var i = 0; - for ( ; i < l; i++ ) { - if ( jQuery.contains( this, targets[i] ) ) { - return true; - } - } - }); - }, - - closest: function( selectors, context ) { - var cur, - i = 0, - l = this.length, - matched = [], - pos = rneedsContext.test( selectors ) || typeof selectors !== "string" ? - jQuery( selectors, context || this.context ) : - 0; - - for ( ; i < l; i++ ) { - for ( cur = this[i]; cur && cur !== context; cur = cur.parentNode ) { - // Always skip document fragments - if ( cur.nodeType < 11 && (pos ? - pos.index(cur) > -1 : - - // Don't pass non-elements to Sizzle - cur.nodeType === 1 && - jQuery.find.matchesSelector(cur, selectors)) ) { - - matched.push( cur ); - break; - } - } - } - - return this.pushStack( matched.length > 1 ? jQuery.unique( matched ) : matched ); - }, - - // Determine the position of an element within - // the matched set of elements - index: function( elem ) { - - // No argument, return index in parent - if ( !elem ) { - return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; - } - - // index in selector - if ( typeof elem === "string" ) { - return indexOf.call( jQuery( elem ), this[ 0 ] ); - } - - // Locate the position of the desired element - return indexOf.call( this, - - // If it receives a jQuery object, the first element is used - elem.jquery ? elem[ 0 ] : elem - ); - }, - - add: function( selector, context ) { - return this.pushStack( - jQuery.unique( - jQuery.merge( this.get(), jQuery( selector, context ) ) - ) - ); - }, - - addBack: function( selector ) { - return this.add( selector == null ? - this.prevObject : this.prevObject.filter(selector) - ); - } -}); - -function sibling( cur, dir ) { - while ( (cur = cur[dir]) && cur.nodeType !== 1 ) {} - return cur; -} - -jQuery.each({ - parent: function( elem ) { - var parent = elem.parentNode; - return parent && parent.nodeType !== 11 ? parent : null; - }, - parents: function( elem ) { - return jQuery.dir( elem, "parentNode" ); - }, - parentsUntil: function( elem, i, until ) { - return jQuery.dir( elem, "parentNode", until ); - }, - next: function( elem ) { - return sibling( elem, "nextSibling" ); - }, - prev: function( elem ) { - return sibling( elem, "previousSibling" ); - }, - nextAll: function( elem ) { - return jQuery.dir( elem, "nextSibling" ); - }, - prevAll: function( elem ) { - return jQuery.dir( elem, "previousSibling" ); - }, - nextUntil: function( elem, i, until ) { - return jQuery.dir( elem, "nextSibling", until ); - }, - prevUntil: function( elem, i, until ) { - return jQuery.dir( elem, "previousSibling", until ); - }, - siblings: function( elem ) { - return jQuery.sibling( ( elem.parentNode || {} ).firstChild, elem ); - }, - children: function( elem ) { - return jQuery.sibling( elem.firstChild ); - }, - contents: function( elem ) { - return elem.contentDocument || jQuery.merge( [], elem.childNodes ); - } -}, function( name, fn ) { - jQuery.fn[ name ] = function( until, selector ) { - var matched = jQuery.map( this, fn, until ); - - if ( name.slice( -5 ) !== "Until" ) { - selector = until; - } - - if ( selector && typeof selector === "string" ) { - matched = jQuery.filter( selector, matched ); - } - - if ( this.length > 1 ) { - // Remove duplicates - if ( !guaranteedUnique[ name ] ) { - jQuery.unique( matched ); - } - - // Reverse order for parents* and prev-derivatives - if ( rparentsprev.test( name ) ) { - matched.reverse(); - } - } - - return this.pushStack( matched ); - }; -}); -var rnotwhite = (/\S+/g); - - - -// String to Object options format cache -var optionsCache = {}; - -// Convert String-formatted options into Object-formatted ones and store in cache -function createOptions( options ) { - var object = optionsCache[ options ] = {}; - jQuery.each( options.match( rnotwhite ) || [], function( _, flag ) { - object[ flag ] = true; - }); - return object; -} - -/* - * Create a callback list using the following parameters: - * - * options: an optional list of space-separated options that will change how - * the callback list behaves or a more traditional option object - * - * By default a callback list will act like an event callback list and can be - * "fired" multiple times. - * - * Possible options: - * - * once: will ensure the callback list can only be fired once (like a Deferred) - * - * memory: will keep track of previous values and will call any callback added - * after the list has been fired right away with the latest "memorized" - * values (like a Deferred) - * - * unique: will ensure a callback can only be added once (no duplicate in the list) - * - * stopOnFalse: interrupt callings when a callback returns false - * - */ -jQuery.Callbacks = function( options ) { - - // Convert options from String-formatted to Object-formatted if needed - // (we check in cache first) - options = typeof options === "string" ? - ( optionsCache[ options ] || createOptions( options ) ) : - jQuery.extend( {}, options ); - - var // Last fire value (for non-forgettable lists) - memory, - // Flag to know if list was already fired - fired, - // Flag to know if list is currently firing - firing, - // First callback to fire (used internally by add and fireWith) - firingStart, - // End of the loop when firing - firingLength, - // Index of currently firing callback (modified by remove if needed) - firingIndex, - // Actual callback list - list = [], - // Stack of fire calls for repeatable lists - stack = !options.once && [], - // Fire callbacks - fire = function( data ) { - memory = options.memory && data; - fired = true; - firingIndex = firingStart || 0; - firingStart = 0; - firingLength = list.length; - firing = true; - for ( ; list && firingIndex < firingLength; firingIndex++ ) { - if ( list[ firingIndex ].apply( data[ 0 ], data[ 1 ] ) === false && options.stopOnFalse ) { - memory = false; // To prevent further calls using add - break; - } - } - firing = false; - if ( list ) { - if ( stack ) { - if ( stack.length ) { - fire( stack.shift() ); - } - } else if ( memory ) { - list = []; - } else { - self.disable(); - } - } - }, - // Actual Callbacks object - self = { - // Add a callback or a collection of callbacks to the list - add: function() { - if ( list ) { - // First, we save the current length - var start = list.length; - (function add( args ) { - jQuery.each( args, function( _, arg ) { - var type = jQuery.type( arg ); - if ( type === "function" ) { - if ( !options.unique || !self.has( arg ) ) { - list.push( arg ); - } - } else if ( arg && arg.length && type !== "string" ) { - // Inspect recursively - add( arg ); - } - }); - })( arguments ); - // Do we need to add the callbacks to the - // current firing batch? - if ( firing ) { - firingLength = list.length; - // With memory, if we're not firing then - // we should call right away - } else if ( memory ) { - firingStart = start; - fire( memory ); - } - } - return this; - }, - // Remove a callback from the list - remove: function() { - if ( list ) { - jQuery.each( arguments, function( _, arg ) { - var index; - while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { - list.splice( index, 1 ); - // Handle firing indexes - if ( firing ) { - if ( index <= firingLength ) { - firingLength--; - } - if ( index <= firingIndex ) { - firingIndex--; - } - } - } - }); - } - return this; - }, - // Check if a given callback is in the list. - // If no argument is given, return whether or not list has callbacks attached. - has: function( fn ) { - return fn ? jQuery.inArray( fn, list ) > -1 : !!( list && list.length ); - }, - // Remove all callbacks from the list - empty: function() { - list = []; - firingLength = 0; - return this; - }, - // Have the list do nothing anymore - disable: function() { - list = stack = memory = undefined; - return this; - }, - // Is it disabled? - disabled: function() { - return !list; - }, - // Lock the list in its current state - lock: function() { - stack = undefined; - if ( !memory ) { - self.disable(); - } - return this; - }, - // Is it locked? - locked: function() { - return !stack; - }, - // Call all callbacks with the given context and arguments - fireWith: function( context, args ) { - if ( list && ( !fired || stack ) ) { - args = args || []; - args = [ context, args.slice ? args.slice() : args ]; - if ( firing ) { - stack.push( args ); - } else { - fire( args ); - } - } - return this; - }, - // Call all the callbacks with the given arguments - fire: function() { - self.fireWith( this, arguments ); - return this; - }, - // To know if the callbacks have already been called at least once - fired: function() { - return !!fired; - } - }; - - return self; -}; - - -jQuery.extend({ - - Deferred: function( func ) { - var tuples = [ - // action, add listener, listener list, final state - [ "resolve", "done", jQuery.Callbacks("once memory"), "resolved" ], - [ "reject", "fail", jQuery.Callbacks("once memory"), "rejected" ], - [ "notify", "progress", jQuery.Callbacks("memory") ] - ], - state = "pending", - promise = { - state: function() { - return state; - }, - always: function() { - deferred.done( arguments ).fail( arguments ); - return this; - }, - then: function( /* fnDone, fnFail, fnProgress */ ) { - var fns = arguments; - return jQuery.Deferred(function( newDefer ) { - jQuery.each( tuples, function( i, tuple ) { - var fn = jQuery.isFunction( fns[ i ] ) && fns[ i ]; - // deferred[ done | fail | progress ] for forwarding actions to newDefer - deferred[ tuple[1] ](function() { - var returned = fn && fn.apply( this, arguments ); - if ( returned && jQuery.isFunction( returned.promise ) ) { - returned.promise() - .done( newDefer.resolve ) - .fail( newDefer.reject ) - .progress( newDefer.notify ); - } else { - newDefer[ tuple[ 0 ] + "With" ]( this === promise ? newDefer.promise() : this, fn ? [ returned ] : arguments ); - } - }); - }); - fns = null; - }).promise(); - }, - // Get a promise for this deferred - // If obj is provided, the promise aspect is added to the object - promise: function( obj ) { - return obj != null ? jQuery.extend( obj, promise ) : promise; - } - }, - deferred = {}; - - // Keep pipe for back-compat - promise.pipe = promise.then; - - // Add list-specific methods - jQuery.each( tuples, function( i, tuple ) { - var list = tuple[ 2 ], - stateString = tuple[ 3 ]; - - // promise[ done | fail | progress ] = list.add - promise[ tuple[1] ] = list.add; - - // Handle state - if ( stateString ) { - list.add(function() { - // state = [ resolved | rejected ] - state = stateString; - - // [ reject_list | resolve_list ].disable; progress_list.lock - }, tuples[ i ^ 1 ][ 2 ].disable, tuples[ 2 ][ 2 ].lock ); - } - - // deferred[ resolve | reject | notify ] - deferred[ tuple[0] ] = function() { - deferred[ tuple[0] + "With" ]( this === deferred ? promise : this, arguments ); - return this; - }; - deferred[ tuple[0] + "With" ] = list.fireWith; - }); - - // Make the deferred a promise - promise.promise( deferred ); - - // Call given func if any - if ( func ) { - func.call( deferred, deferred ); - } - - // All done! - return deferred; - }, - - // Deferred helper - when: function( subordinate /* , ..., subordinateN */ ) { - var i = 0, - resolveValues = slice.call( arguments ), - length = resolveValues.length, - - // the count of uncompleted subordinates - remaining = length !== 1 || ( subordinate && jQuery.isFunction( subordinate.promise ) ) ? length : 0, - - // the master Deferred. If resolveValues consist of only a single Deferred, just use that. - deferred = remaining === 1 ? subordinate : jQuery.Deferred(), - - // Update function for both resolve and progress values - updateFunc = function( i, contexts, values ) { - return function( value ) { - contexts[ i ] = this; - values[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; - if ( values === progressValues ) { - deferred.notifyWith( contexts, values ); - } else if ( !( --remaining ) ) { - deferred.resolveWith( contexts, values ); - } - }; - }, - - progressValues, progressContexts, resolveContexts; - - // add listeners to Deferred subordinates; treat others as resolved - if ( length > 1 ) { - progressValues = new Array( length ); - progressContexts = new Array( length ); - resolveContexts = new Array( length ); - for ( ; i < length; i++ ) { - if ( resolveValues[ i ] && jQuery.isFunction( resolveValues[ i ].promise ) ) { - resolveValues[ i ].promise() - .done( updateFunc( i, resolveContexts, resolveValues ) ) - .fail( deferred.reject ) - .progress( updateFunc( i, progressContexts, progressValues ) ); - } else { - --remaining; - } - } - } - - // if we're not waiting on anything, resolve the master - if ( !remaining ) { - deferred.resolveWith( resolveContexts, resolveValues ); - } - - return deferred.promise(); - } -}); - - -// The deferred used on DOM ready -var readyList; - -jQuery.fn.ready = function( fn ) { - // Add the callback - jQuery.ready.promise().done( fn ); - - return this; -}; - -jQuery.extend({ - // Is the DOM ready to be used? Set to true once it occurs. - isReady: false, - - // A counter to track how many items to wait for before - // the ready event fires. See #6781 - readyWait: 1, - - // Hold (or release) the ready event - holdReady: function( hold ) { - if ( hold ) { - jQuery.readyWait++; - } else { - jQuery.ready( true ); - } - }, - - // Handle when the DOM is ready - ready: function( wait ) { - - // Abort if there are pending holds or we're already ready - if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { - return; - } - - // Remember that the DOM is ready - jQuery.isReady = true; - - // If a normal DOM Ready event fired, decrement, and wait if need be - if ( wait !== true && --jQuery.readyWait > 0 ) { - return; - } - - // If there are functions bound, to execute - readyList.resolveWith( document, [ jQuery ] ); - - // Trigger any bound ready events - if ( jQuery.fn.triggerHandler ) { - jQuery( document ).triggerHandler( "ready" ); - jQuery( document ).off( "ready" ); - } - } -}); - -/** - * The ready event handler and self cleanup method - */ -function completed() { - document.removeEventListener( "DOMContentLoaded", completed, false ); - window.removeEventListener( "load", completed, false ); - jQuery.ready(); -} - -jQuery.ready.promise = function( obj ) { - if ( !readyList ) { - - readyList = jQuery.Deferred(); - - // Catch cases where $(document).ready() is called after the browser event has already occurred. - // we once tried to use readyState "interactive" here, but it caused issues like the one - // discovered by ChrisS here: http://bugs.jquery.com/ticket/12282#comment:15 - if ( document.readyState === "complete" ) { - // Handle it asynchronously to allow scripts the opportunity to delay ready - setTimeout( jQuery.ready ); - - } else { - - // Use the handy event callback - document.addEventListener( "DOMContentLoaded", completed, false ); - - // A fallback to window.onload, that will always work - window.addEventListener( "load", completed, false ); - } - } - return readyList.promise( obj ); -}; - -// Kick off the DOM ready check even if the user does not -jQuery.ready.promise(); - - - - -// Multifunctional method to get and set values of a collection -// The value/s can optionally be executed if it's a function -var access = jQuery.access = function( elems, fn, key, value, chainable, emptyGet, raw ) { - var i = 0, - len = elems.length, - bulk = key == null; - - // Sets many values - if ( jQuery.type( key ) === "object" ) { - chainable = true; - for ( i in key ) { - jQuery.access( elems, fn, i, key[i], true, emptyGet, raw ); - } - - // Sets one value - } else if ( value !== undefined ) { - chainable = true; - - if ( !jQuery.isFunction( value ) ) { - raw = true; - } - - if ( bulk ) { - // Bulk operations run against the entire set - if ( raw ) { - fn.call( elems, value ); - fn = null; - - // ...except when executing function values - } else { - bulk = fn; - fn = function( elem, key, value ) { - return bulk.call( jQuery( elem ), value ); - }; - } - } - - if ( fn ) { - for ( ; i < len; i++ ) { - fn( elems[i], key, raw ? value : value.call( elems[i], i, fn( elems[i], key ) ) ); - } - } - } - - return chainable ? - elems : - - // Gets - bulk ? - fn.call( elems ) : - len ? fn( elems[0], key ) : emptyGet; -}; - - -/** - * Determines whether an object can have data - */ -jQuery.acceptData = function( owner ) { - // Accepts only: - // - Node - // - Node.ELEMENT_NODE - // - Node.DOCUMENT_NODE - // - Object - // - Any - /* jshint -W018 */ - return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); -}; - - -function Data() { - // Support: Android < 4, - // Old WebKit does not have Object.preventExtensions/freeze method, - // return new empty object instead with no [[set]] accessor - Object.defineProperty( this.cache = {}, 0, { - get: function() { - return {}; - } - }); - - this.expando = jQuery.expando + Math.random(); -} - -Data.uid = 1; -Data.accepts = jQuery.acceptData; - -Data.prototype = { - key: function( owner ) { - // We can accept data for non-element nodes in modern browsers, - // but we should not, see #8335. - // Always return the key for a frozen object. - if ( !Data.accepts( owner ) ) { - return 0; - } - - var descriptor = {}, - // Check if the owner object already has a cache key - unlock = owner[ this.expando ]; - - // If not, create one - if ( !unlock ) { - unlock = Data.uid++; - - // Secure it in a non-enumerable, non-writable property - try { - descriptor[ this.expando ] = { value: unlock }; - Object.defineProperties( owner, descriptor ); - - // Support: Android < 4 - // Fallback to a less secure definition - } catch ( e ) { - descriptor[ this.expando ] = unlock; - jQuery.extend( owner, descriptor ); - } - } - - // Ensure the cache object - if ( !this.cache[ unlock ] ) { - this.cache[ unlock ] = {}; - } - - return unlock; - }, - set: function( owner, data, value ) { - var prop, - // There may be an unlock assigned to this node, - // if there is no entry for this "owner", create one inline - // and set the unlock as though an owner entry had always existed - unlock = this.key( owner ), - cache = this.cache[ unlock ]; - - // Handle: [ owner, key, value ] args - if ( typeof data === "string" ) { - cache[ data ] = value; - - // Handle: [ owner, { properties } ] args - } else { - // Fresh assignments by object are shallow copied - if ( jQuery.isEmptyObject( cache ) ) { - jQuery.extend( this.cache[ unlock ], data ); - // Otherwise, copy the properties one-by-one to the cache object - } else { - for ( prop in data ) { - cache[ prop ] = data[ prop ]; - } - } - } - return cache; - }, - get: function( owner, key ) { - // Either a valid cache is found, or will be created. - // New caches will be created and the unlock returned, - // allowing direct access to the newly created - // empty data object. A valid owner object must be provided. - var cache = this.cache[ this.key( owner ) ]; - - return key === undefined ? - cache : cache[ key ]; - }, - access: function( owner, key, value ) { - var stored; - // In cases where either: - // - // 1. No key was specified - // 2. A string key was specified, but no value provided - // - // Take the "read" path and allow the get method to determine - // which value to return, respectively either: - // - // 1. The entire cache object - // 2. The data stored at the key - // - if ( key === undefined || - ((key && typeof key === "string") && value === undefined) ) { - - stored = this.get( owner, key ); - - return stored !== undefined ? - stored : this.get( owner, jQuery.camelCase(key) ); - } - - // [*]When the key is not a string, or both a key and value - // are specified, set or extend (existing objects) with either: - // - // 1. An object of properties - // 2. A key and value - // - this.set( owner, key, value ); - - // Since the "set" path can have two possible entry points - // return the expected data based on which path was taken[*] - return value !== undefined ? value : key; - }, - remove: function( owner, key ) { - var i, name, camel, - unlock = this.key( owner ), - cache = this.cache[ unlock ]; - - if ( key === undefined ) { - this.cache[ unlock ] = {}; - - } else { - // Support array or space separated string of keys - if ( jQuery.isArray( key ) ) { - // If "name" is an array of keys... - // When data is initially created, via ("key", "val") signature, - // keys will be converted to camelCase. - // Since there is no way to tell _how_ a key was added, remove - // both plain key and camelCase key. #12786 - // This will only penalize the array argument path. - name = key.concat( key.map( jQuery.camelCase ) ); - } else { - camel = jQuery.camelCase( key ); - // Try the string as a key before any manipulation - if ( key in cache ) { - name = [ key, camel ]; - } else { - // If a key with the spaces exists, use it. - // Otherwise, create an array by matching non-whitespace - name = camel; - name = name in cache ? - [ name ] : ( name.match( rnotwhite ) || [] ); - } - } - - i = name.length; - while ( i-- ) { - delete cache[ name[ i ] ]; - } - } - }, - hasData: function( owner ) { - return !jQuery.isEmptyObject( - this.cache[ owner[ this.expando ] ] || {} - ); - }, - discard: function( owner ) { - if ( owner[ this.expando ] ) { - delete this.cache[ owner[ this.expando ] ]; - } - } -}; -var data_priv = new Data(); - -var data_user = new Data(); - - - -/* - Implementation Summary - - 1. Enforce API surface and semantic compatibility with 1.9.x branch - 2. Improve the module's maintainability by reducing the storage - paths to a single mechanism. - 3. Use the same single mechanism to support "private" and "user" data. - 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) - 5. Avoid exposing implementation details on user objects (eg. expando properties) - 6. Provide a clear path for implementation upgrade to WeakMap in 2014 -*/ -var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, - rmultiDash = /([A-Z])/g; - -function dataAttr( elem, key, data ) { - var name; - - // If nothing was found internally, try to fetch any - // data from the HTML5 data-* attribute - if ( data === undefined && elem.nodeType === 1 ) { - name = "data-" + key.replace( rmultiDash, "-$1" ).toLowerCase(); - data = elem.getAttribute( name ); - - if ( typeof data === "string" ) { - try { - data = data === "true" ? true : - data === "false" ? false : - data === "null" ? null : - // Only convert to a number if it doesn't change the string - +data + "" === data ? +data : - rbrace.test( data ) ? jQuery.parseJSON( data ) : - data; - } catch( e ) {} - - // Make sure we set the data so it isn't changed later - data_user.set( elem, key, data ); - } else { - data = undefined; - } - } - return data; -} - -jQuery.extend({ - hasData: function( elem ) { - return data_user.hasData( elem ) || data_priv.hasData( elem ); - }, - - data: function( elem, name, data ) { - return data_user.access( elem, name, data ); - }, - - removeData: function( elem, name ) { - data_user.remove( elem, name ); - }, - - // TODO: Now that all calls to _data and _removeData have been replaced - // with direct calls to data_priv methods, these can be deprecated. - _data: function( elem, name, data ) { - return data_priv.access( elem, name, data ); - }, - - _removeData: function( elem, name ) { - data_priv.remove( elem, name ); - } -}); - -jQuery.fn.extend({ - data: function( key, value ) { - var i, name, data, - elem = this[ 0 ], - attrs = elem && elem.attributes; - - // Gets all values - if ( key === undefined ) { - if ( this.length ) { - data = data_user.get( elem ); - - if ( elem.nodeType === 1 && !data_priv.get( elem, "hasDataAttrs" ) ) { - i = attrs.length; - while ( i-- ) { - - // Support: IE11+ - // The attrs elements can be null (#14894) - if ( attrs[ i ] ) { - name = attrs[ i ].name; - if ( name.indexOf( "data-" ) === 0 ) { - name = jQuery.camelCase( name.slice(5) ); - dataAttr( elem, name, data[ name ] ); - } - } - } - data_priv.set( elem, "hasDataAttrs", true ); - } - } - - return data; - } - - // Sets multiple values - if ( typeof key === "object" ) { - return this.each(function() { - data_user.set( this, key ); - }); - } - - return access( this, function( value ) { - var data, - camelKey = jQuery.camelCase( key ); - - // The calling jQuery object (element matches) is not empty - // (and therefore has an element appears at this[ 0 ]) and the - // `value` parameter was not undefined. An empty jQuery object - // will result in `undefined` for elem = this[ 0 ] which will - // throw an exception if an attempt to read a data cache is made. - if ( elem && value === undefined ) { - // Attempt to get data from the cache - // with the key as-is - data = data_user.get( elem, key ); - if ( data !== undefined ) { - return data; - } - - // Attempt to get data from the cache - // with the key camelized - data = data_user.get( elem, camelKey ); - if ( data !== undefined ) { - return data; - } - - // Attempt to "discover" the data in - // HTML5 custom data-* attrs - data = dataAttr( elem, camelKey, undefined ); - if ( data !== undefined ) { - return data; - } - - // We tried really hard, but the data doesn't exist. - return; - } - - // Set the data... - this.each(function() { - // First, attempt to store a copy or reference of any - // data that might've been store with a camelCased key. - var data = data_user.get( this, camelKey ); - - // For HTML5 data-* attribute interop, we have to - // store property names with dashes in a camelCase form. - // This might not apply to all properties...* - data_user.set( this, camelKey, value ); - - // *... In the case of properties that might _actually_ - // have dashes, we need to also store a copy of that - // unchanged property. - if ( key.indexOf("-") !== -1 && data !== undefined ) { - data_user.set( this, key, value ); - } - }); - }, null, value, arguments.length > 1, null, true ); - }, - - removeData: function( key ) { - return this.each(function() { - data_user.remove( this, key ); - }); - } -}); - - -jQuery.extend({ - queue: function( elem, type, data ) { - var queue; - - if ( elem ) { - type = ( type || "fx" ) + "queue"; - queue = data_priv.get( elem, type ); - - // Speed up dequeue by getting out quickly if this is just a lookup - if ( data ) { - if ( !queue || jQuery.isArray( data ) ) { - queue = data_priv.access( elem, type, jQuery.makeArray(data) ); - } else { - queue.push( data ); - } - } - return queue || []; - } - }, - - dequeue: function( elem, type ) { - type = type || "fx"; - - var queue = jQuery.queue( elem, type ), - startLength = queue.length, - fn = queue.shift(), - hooks = jQuery._queueHooks( elem, type ), - next = function() { - jQuery.dequeue( elem, type ); - }; - - // If the fx queue is dequeued, always remove the progress sentinel - if ( fn === "inprogress" ) { - fn = queue.shift(); - startLength--; - } - - if ( fn ) { - - // Add a progress sentinel to prevent the fx queue from being - // automatically dequeued - if ( type === "fx" ) { - queue.unshift( "inprogress" ); - } - - // clear up the last queue stop function - delete hooks.stop; - fn.call( elem, next, hooks ); - } - - if ( !startLength && hooks ) { - hooks.empty.fire(); - } - }, - - // not intended for public consumption - generates a queueHooks object, or returns the current one - _queueHooks: function( elem, type ) { - var key = type + "queueHooks"; - return data_priv.get( elem, key ) || data_priv.access( elem, key, { - empty: jQuery.Callbacks("once memory").add(function() { - data_priv.remove( elem, [ type + "queue", key ] ); - }) - }); - } -}); - -jQuery.fn.extend({ - queue: function( type, data ) { - var setter = 2; - - if ( typeof type !== "string" ) { - data = type; - type = "fx"; - setter--; - } - - if ( arguments.length < setter ) { - return jQuery.queue( this[0], type ); - } - - return data === undefined ? - this : - this.each(function() { - var queue = jQuery.queue( this, type, data ); - - // ensure a hooks for this queue - jQuery._queueHooks( this, type ); - - if ( type === "fx" && queue[0] !== "inprogress" ) { - jQuery.dequeue( this, type ); - } - }); - }, - dequeue: function( type ) { - return this.each(function() { - jQuery.dequeue( this, type ); - }); - }, - clearQueue: function( type ) { - return this.queue( type || "fx", [] ); - }, - // Get a promise resolved when queues of a certain type - // are emptied (fx is the type by default) - promise: function( type, obj ) { - var tmp, - count = 1, - defer = jQuery.Deferred(), - elements = this, - i = this.length, - resolve = function() { - if ( !( --count ) ) { - defer.resolveWith( elements, [ elements ] ); - } - }; - - if ( typeof type !== "string" ) { - obj = type; - type = undefined; - } - type = type || "fx"; - - while ( i-- ) { - tmp = data_priv.get( elements[ i ], type + "queueHooks" ); - if ( tmp && tmp.empty ) { - count++; - tmp.empty.add( resolve ); - } - } - resolve(); - return defer.promise( obj ); - } -}); -var pnum = (/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/).source; - -var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; - -var isHidden = function( elem, el ) { - // isHidden might be called from jQuery#filter function; - // in that case, element will be second argument - elem = el || elem; - return jQuery.css( elem, "display" ) === "none" || !jQuery.contains( elem.ownerDocument, elem ); - }; - -var rcheckableType = (/^(?:checkbox|radio)$/i); - - - -(function() { - var fragment = document.createDocumentFragment(), - div = fragment.appendChild( document.createElement( "div" ) ), - input = document.createElement( "input" ); - - // #11217 - WebKit loses check when the name is after the checked attribute - // Support: Windows Web Apps (WWA) - // `name` and `type` need .setAttribute for WWA - input.setAttribute( "type", "radio" ); - input.setAttribute( "checked", "checked" ); - input.setAttribute( "name", "t" ); - - div.appendChild( input ); - - // Support: Safari 5.1, iOS 5.1, Android 4.x, Android 2.3 - // old WebKit doesn't clone checked state correctly in fragments - support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; - - // Make sure textarea (and checkbox) defaultValue is properly cloned - // Support: IE9-IE11+ - div.innerHTML = ""; - support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; -})(); -var strundefined = typeof undefined; - - - -support.focusinBubbles = "onfocusin" in window; - - -var - rkeyEvent = /^key/, - rmouseEvent = /^(?:mouse|pointer|contextmenu)|click/, - rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, - rtypenamespace = /^([^.]*)(?:\.(.+)|)$/; - -function returnTrue() { - return true; -} - -function returnFalse() { - return false; -} - -function safeActiveElement() { - try { - return document.activeElement; - } catch ( err ) { } -} - -/* - * Helper functions for managing events -- not part of the public interface. - * Props to Dean Edwards' addEvent library for many of the ideas. - */ -jQuery.event = { - - global: {}, - - add: function( elem, types, handler, data, selector ) { - - var handleObjIn, eventHandle, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = data_priv.get( elem ); - - // Don't attach events to noData or text/comment nodes (but allow plain objects) - if ( !elemData ) { - return; - } - - // Caller can pass in an object of custom data in lieu of the handler - if ( handler.handler ) { - handleObjIn = handler; - handler = handleObjIn.handler; - selector = handleObjIn.selector; - } - - // Make sure that the handler has a unique ID, used to find/remove it later - if ( !handler.guid ) { - handler.guid = jQuery.guid++; - } - - // Init the element's event structure and main handler, if this is the first - if ( !(events = elemData.events) ) { - events = elemData.events = {}; - } - if ( !(eventHandle = elemData.handle) ) { - eventHandle = elemData.handle = function( e ) { - // Discard the second event of a jQuery.event.trigger() and - // when an event is called after a page has unloaded - return typeof jQuery !== strundefined && jQuery.event.triggered !== e.type ? - jQuery.event.dispatch.apply( elem, arguments ) : undefined; - }; - } - - // Handle multiple events separated by a space - types = ( types || "" ).match( rnotwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[t] ) || []; - type = origType = tmp[1]; - namespaces = ( tmp[2] || "" ).split( "." ).sort(); - - // There *must* be a type, no attaching namespace-only handlers - if ( !type ) { - continue; - } - - // If event changes its type, use the special event handlers for the changed type - special = jQuery.event.special[ type ] || {}; - - // If selector defined, determine special event api type, otherwise given type - type = ( selector ? special.delegateType : special.bindType ) || type; - - // Update special based on newly reset type - special = jQuery.event.special[ type ] || {}; - - // handleObj is passed to all event handlers - handleObj = jQuery.extend({ - type: type, - origType: origType, - data: data, - handler: handler, - guid: handler.guid, - selector: selector, - needsContext: selector && jQuery.expr.match.needsContext.test( selector ), - namespace: namespaces.join(".") - }, handleObjIn ); - - // Init the event handler queue if we're the first - if ( !(handlers = events[ type ]) ) { - handlers = events[ type ] = []; - handlers.delegateCount = 0; - - // Only use addEventListener if the special events handler returns false - if ( !special.setup || special.setup.call( elem, data, namespaces, eventHandle ) === false ) { - if ( elem.addEventListener ) { - elem.addEventListener( type, eventHandle, false ); - } - } - } - - if ( special.add ) { - special.add.call( elem, handleObj ); - - if ( !handleObj.handler.guid ) { - handleObj.handler.guid = handler.guid; - } - } - - // Add to the element's handler list, delegates in front - if ( selector ) { - handlers.splice( handlers.delegateCount++, 0, handleObj ); - } else { - handlers.push( handleObj ); - } - - // Keep track of which events have ever been used, for event optimization - jQuery.event.global[ type ] = true; - } - - }, - - // Detach an event or set of events from an element - remove: function( elem, types, handler, selector, mappedTypes ) { - - var j, origCount, tmp, - events, t, handleObj, - special, handlers, type, namespaces, origType, - elemData = data_priv.hasData( elem ) && data_priv.get( elem ); - - if ( !elemData || !(events = elemData.events) ) { - return; - } - - // Once for each type.namespace in types; type may be omitted - types = ( types || "" ).match( rnotwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[t] ) || []; - type = origType = tmp[1]; - namespaces = ( tmp[2] || "" ).split( "." ).sort(); - - // Unbind all events (on this namespace, if provided) for the element - if ( !type ) { - for ( type in events ) { - jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); - } - continue; - } - - special = jQuery.event.special[ type ] || {}; - type = ( selector ? special.delegateType : special.bindType ) || type; - handlers = events[ type ] || []; - tmp = tmp[2] && new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ); - - // Remove matching events - origCount = j = handlers.length; - while ( j-- ) { - handleObj = handlers[ j ]; - - if ( ( mappedTypes || origType === handleObj.origType ) && - ( !handler || handler.guid === handleObj.guid ) && - ( !tmp || tmp.test( handleObj.namespace ) ) && - ( !selector || selector === handleObj.selector || selector === "**" && handleObj.selector ) ) { - handlers.splice( j, 1 ); - - if ( handleObj.selector ) { - handlers.delegateCount--; - } - if ( special.remove ) { - special.remove.call( elem, handleObj ); - } - } - } - - // Remove generic event handler if we removed something and no more handlers exist - // (avoids potential for endless recursion during removal of special event handlers) - if ( origCount && !handlers.length ) { - if ( !special.teardown || special.teardown.call( elem, namespaces, elemData.handle ) === false ) { - jQuery.removeEvent( elem, type, elemData.handle ); - } - - delete events[ type ]; - } - } - - // Remove the expando if it's no longer used - if ( jQuery.isEmptyObject( events ) ) { - delete elemData.handle; - data_priv.remove( elem, "events" ); - } - }, - - trigger: function( event, data, elem, onlyHandlers ) { - - var i, cur, tmp, bubbleType, ontype, handle, special, - eventPath = [ elem || document ], - type = hasOwn.call( event, "type" ) ? event.type : event, - namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split(".") : []; - - cur = tmp = elem = elem || document; - - // Don't do events on text and comment nodes - if ( elem.nodeType === 3 || elem.nodeType === 8 ) { - return; - } - - // focus/blur morphs to focusin/out; ensure we're not firing them right now - if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { - return; - } - - if ( type.indexOf(".") >= 0 ) { - // Namespaced trigger; create a regexp to match event type in handle() - namespaces = type.split("."); - type = namespaces.shift(); - namespaces.sort(); - } - ontype = type.indexOf(":") < 0 && "on" + type; - - // Caller can pass in a jQuery.Event object, Object, or just an event type string - event = event[ jQuery.expando ] ? - event : - new jQuery.Event( type, typeof event === "object" && event ); - - // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) - event.isTrigger = onlyHandlers ? 2 : 3; - event.namespace = namespaces.join("."); - event.namespace_re = event.namespace ? - new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ) : - null; - - // Clean up the event in case it is being reused - event.result = undefined; - if ( !event.target ) { - event.target = elem; - } - - // Clone any incoming data and prepend the event, creating the handler arg list - data = data == null ? - [ event ] : - jQuery.makeArray( data, [ event ] ); - - // Allow special events to draw outside the lines - special = jQuery.event.special[ type ] || {}; - if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { - return; - } - - // Determine event propagation path in advance, per W3C events spec (#9951) - // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) - if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { - - bubbleType = special.delegateType || type; - if ( !rfocusMorph.test( bubbleType + type ) ) { - cur = cur.parentNode; - } - for ( ; cur; cur = cur.parentNode ) { - eventPath.push( cur ); - tmp = cur; - } - - // Only add window if we got to document (e.g., not plain obj or detached DOM) - if ( tmp === (elem.ownerDocument || document) ) { - eventPath.push( tmp.defaultView || tmp.parentWindow || window ); - } - } - - // Fire handlers on the event path - i = 0; - while ( (cur = eventPath[i++]) && !event.isPropagationStopped() ) { - - event.type = i > 1 ? - bubbleType : - special.bindType || type; - - // jQuery handler - handle = ( data_priv.get( cur, "events" ) || {} )[ event.type ] && data_priv.get( cur, "handle" ); - if ( handle ) { - handle.apply( cur, data ); - } - - // Native handler - handle = ontype && cur[ ontype ]; - if ( handle && handle.apply && jQuery.acceptData( cur ) ) { - event.result = handle.apply( cur, data ); - if ( event.result === false ) { - event.preventDefault(); - } - } - } - event.type = type; - - // If nobody prevented the default action, do it now - if ( !onlyHandlers && !event.isDefaultPrevented() ) { - - if ( (!special._default || special._default.apply( eventPath.pop(), data ) === false) && - jQuery.acceptData( elem ) ) { - - // Call a native DOM method on the target with the same name name as the event. - // Don't do default actions on window, that's where global variables be (#6170) - if ( ontype && jQuery.isFunction( elem[ type ] ) && !jQuery.isWindow( elem ) ) { - - // Don't re-trigger an onFOO event when we call its FOO() method - tmp = elem[ ontype ]; - - if ( tmp ) { - elem[ ontype ] = null; - } - - // Prevent re-triggering of the same event, since we already bubbled it above - jQuery.event.triggered = type; - elem[ type ](); - jQuery.event.triggered = undefined; - - if ( tmp ) { - elem[ ontype ] = tmp; - } - } - } - } - - return event.result; - }, - - dispatch: function( event ) { - - // Make a writable jQuery.Event from the native event object - event = jQuery.event.fix( event ); - - var i, j, ret, matched, handleObj, - handlerQueue = [], - args = slice.call( arguments ), - handlers = ( data_priv.get( this, "events" ) || {} )[ event.type ] || [], - special = jQuery.event.special[ event.type ] || {}; - - // Use the fix-ed jQuery.Event rather than the (read-only) native event - args[0] = event; - event.delegateTarget = this; - - // Call the preDispatch hook for the mapped type, and let it bail if desired - if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { - return; - } - - // Determine handlers - handlerQueue = jQuery.event.handlers.call( this, event, handlers ); - - // Run delegates first; they may want to stop propagation beneath us - i = 0; - while ( (matched = handlerQueue[ i++ ]) && !event.isPropagationStopped() ) { - event.currentTarget = matched.elem; - - j = 0; - while ( (handleObj = matched.handlers[ j++ ]) && !event.isImmediatePropagationStopped() ) { - - // Triggered event must either 1) have no namespace, or - // 2) have namespace(s) a subset or equal to those in the bound event (both can have no namespace). - if ( !event.namespace_re || event.namespace_re.test( handleObj.namespace ) ) { - - event.handleObj = handleObj; - event.data = handleObj.data; - - ret = ( (jQuery.event.special[ handleObj.origType ] || {}).handle || handleObj.handler ) - .apply( matched.elem, args ); - - if ( ret !== undefined ) { - if ( (event.result = ret) === false ) { - event.preventDefault(); - event.stopPropagation(); - } - } - } - } - } - - // Call the postDispatch hook for the mapped type - if ( special.postDispatch ) { - special.postDispatch.call( this, event ); - } - - return event.result; - }, - - handlers: function( event, handlers ) { - var i, matches, sel, handleObj, - handlerQueue = [], - delegateCount = handlers.delegateCount, - cur = event.target; - - // Find delegate handlers - // Black-hole SVG instance trees (#13180) - // Avoid non-left-click bubbling in Firefox (#3861) - if ( delegateCount && cur.nodeType && (!event.button || event.type !== "click") ) { - - for ( ; cur !== this; cur = cur.parentNode || this ) { - - // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) - if ( cur.disabled !== true || event.type !== "click" ) { - matches = []; - for ( i = 0; i < delegateCount; i++ ) { - handleObj = handlers[ i ]; - - // Don't conflict with Object.prototype properties (#13203) - sel = handleObj.selector + " "; - - if ( matches[ sel ] === undefined ) { - matches[ sel ] = handleObj.needsContext ? - jQuery( sel, this ).index( cur ) >= 0 : - jQuery.find( sel, this, null, [ cur ] ).length; - } - if ( matches[ sel ] ) { - matches.push( handleObj ); - } - } - if ( matches.length ) { - handlerQueue.push({ elem: cur, handlers: matches }); - } - } - } - } - - // Add the remaining (directly-bound) handlers - if ( delegateCount < handlers.length ) { - handlerQueue.push({ elem: this, handlers: handlers.slice( delegateCount ) }); - } - - return handlerQueue; - }, - - // Includes some event props shared by KeyEvent and MouseEvent - props: "altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "), - - fixHooks: {}, - - keyHooks: { - props: "char charCode key keyCode".split(" "), - filter: function( event, original ) { - - // Add which for key events - if ( event.which == null ) { - event.which = original.charCode != null ? original.charCode : original.keyCode; - } - - return event; - } - }, - - mouseHooks: { - props: "button buttons clientX clientY offsetX offsetY pageX pageY screenX screenY toElement".split(" "), - filter: function( event, original ) { - var eventDoc, doc, body, - button = original.button; - - // Calculate pageX/Y if missing and clientX/Y available - if ( event.pageX == null && original.clientX != null ) { - eventDoc = event.target.ownerDocument || document; - doc = eventDoc.documentElement; - body = eventDoc.body; - - event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 ); - event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 ); - } - - // Add which for click: 1 === left; 2 === middle; 3 === right - // Note: button is not normalized, so don't use it - if ( !event.which && button !== undefined ) { - event.which = ( button & 1 ? 1 : ( button & 2 ? 3 : ( button & 4 ? 2 : 0 ) ) ); - } - - return event; - } - }, - - fix: function( event ) { - if ( event[ jQuery.expando ] ) { - return event; - } - - // Create a writable copy of the event object and normalize some properties - var i, prop, copy, - type = event.type, - originalEvent = event, - fixHook = this.fixHooks[ type ]; - - if ( !fixHook ) { - this.fixHooks[ type ] = fixHook = - rmouseEvent.test( type ) ? this.mouseHooks : - rkeyEvent.test( type ) ? this.keyHooks : - {}; - } - copy = fixHook.props ? this.props.concat( fixHook.props ) : this.props; - - event = new jQuery.Event( originalEvent ); - - i = copy.length; - while ( i-- ) { - prop = copy[ i ]; - event[ prop ] = originalEvent[ prop ]; - } - - // Support: Cordova 2.5 (WebKit) (#13255) - // All events should have a target; Cordova deviceready doesn't - if ( !event.target ) { - event.target = document; - } - - // Support: Safari 6.0+, Chrome < 28 - // Target should not be a text node (#504, #13143) - if ( event.target.nodeType === 3 ) { - event.target = event.target.parentNode; - } - - return fixHook.filter ? fixHook.filter( event, originalEvent ) : event; - }, - - special: { - load: { - // Prevent triggered image.load events from bubbling to window.load - noBubble: true - }, - focus: { - // Fire native event if possible so blur/focus sequence is correct - trigger: function() { - if ( this !== safeActiveElement() && this.focus ) { - this.focus(); - return false; - } - }, - delegateType: "focusin" - }, - blur: { - trigger: function() { - if ( this === safeActiveElement() && this.blur ) { - this.blur(); - return false; - } - }, - delegateType: "focusout" - }, - click: { - // For checkbox, fire native event so checked state will be right - trigger: function() { - if ( this.type === "checkbox" && this.click && jQuery.nodeName( this, "input" ) ) { - this.click(); - return false; - } - }, - - // For cross-browser consistency, don't fire native .click() on links - _default: function( event ) { - return jQuery.nodeName( event.target, "a" ); - } - }, - - beforeunload: { - postDispatch: function( event ) { - - // Support: Firefox 20+ - // Firefox doesn't alert if the returnValue field is not set. - if ( event.result !== undefined && event.originalEvent ) { - event.originalEvent.returnValue = event.result; - } - } - } - }, - - simulate: function( type, elem, event, bubble ) { - // Piggyback on a donor event to simulate a different one. - // Fake originalEvent to avoid donor's stopPropagation, but if the - // simulated event prevents default then we do the same on the donor. - var e = jQuery.extend( - new jQuery.Event(), - event, - { - type: type, - isSimulated: true, - originalEvent: {} - } - ); - if ( bubble ) { - jQuery.event.trigger( e, null, elem ); - } else { - jQuery.event.dispatch.call( elem, e ); - } - if ( e.isDefaultPrevented() ) { - event.preventDefault(); - } - } -}; - -jQuery.removeEvent = function( elem, type, handle ) { - if ( elem.removeEventListener ) { - elem.removeEventListener( type, handle, false ); - } -}; - -jQuery.Event = function( src, props ) { - // Allow instantiation without the 'new' keyword - if ( !(this instanceof jQuery.Event) ) { - return new jQuery.Event( src, props ); - } - - // Event object - if ( src && src.type ) { - this.originalEvent = src; - this.type = src.type; - - // Events bubbling up the document may have been marked as prevented - // by a handler lower down the tree; reflect the correct value. - this.isDefaultPrevented = src.defaultPrevented || - src.defaultPrevented === undefined && - // Support: Android < 4.0 - src.returnValue === false ? - returnTrue : - returnFalse; - - // Event type - } else { - this.type = src; - } - - // Put explicitly provided properties onto the event object - if ( props ) { - jQuery.extend( this, props ); - } - - // Create a timestamp if incoming event doesn't have one - this.timeStamp = src && src.timeStamp || jQuery.now(); - - // Mark it as fixed - this[ jQuery.expando ] = true; -}; - -// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding -// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html -jQuery.Event.prototype = { - isDefaultPrevented: returnFalse, - isPropagationStopped: returnFalse, - isImmediatePropagationStopped: returnFalse, - - preventDefault: function() { - var e = this.originalEvent; - - this.isDefaultPrevented = returnTrue; - - if ( e && e.preventDefault ) { - e.preventDefault(); - } - }, - stopPropagation: function() { - var e = this.originalEvent; - - this.isPropagationStopped = returnTrue; - - if ( e && e.stopPropagation ) { - e.stopPropagation(); - } - }, - stopImmediatePropagation: function() { - var e = this.originalEvent; - - this.isImmediatePropagationStopped = returnTrue; - - if ( e && e.stopImmediatePropagation ) { - e.stopImmediatePropagation(); - } - - this.stopPropagation(); - } -}; - -// Create mouseenter/leave events using mouseover/out and event-time checks -// Support: Chrome 15+ -jQuery.each({ - mouseenter: "mouseover", - mouseleave: "mouseout", - pointerenter: "pointerover", - pointerleave: "pointerout" -}, function( orig, fix ) { - jQuery.event.special[ orig ] = { - delegateType: fix, - bindType: fix, - - handle: function( event ) { - var ret, - target = this, - related = event.relatedTarget, - handleObj = event.handleObj; - - // 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 && !jQuery.contains( target, related )) ) { - event.type = handleObj.origType; - ret = handleObj.handler.apply( this, arguments ); - event.type = fix; - } - return ret; - } - }; -}); - -// Create "bubbling" focus and blur events -// Support: Firefox, Chrome, Safari -if ( !support.focusinBubbles ) { - jQuery.each({ focus: "focusin", blur: "focusout" }, function( orig, fix ) { - - // Attach a single capturing handler on the document while someone wants focusin/focusout - var handler = function( event ) { - jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ), true ); - }; - - jQuery.event.special[ fix ] = { - setup: function() { - var doc = this.ownerDocument || this, - attaches = data_priv.access( doc, fix ); - - if ( !attaches ) { - doc.addEventListener( orig, handler, true ); - } - data_priv.access( doc, fix, ( attaches || 0 ) + 1 ); - }, - teardown: function() { - var doc = this.ownerDocument || this, - attaches = data_priv.access( doc, fix ) - 1; - - if ( !attaches ) { - doc.removeEventListener( orig, handler, true ); - data_priv.remove( doc, fix ); - - } else { - data_priv.access( doc, fix, attaches ); - } - } - }; - }); -} - -jQuery.fn.extend({ - - on: function( types, selector, data, fn, /*INTERNAL*/ one ) { - var origFn, type; - - // Types can be a map of types/handlers - if ( typeof types === "object" ) { - // ( types-Object, selector, data ) - if ( typeof selector !== "string" ) { - // ( types-Object, data ) - data = data || selector; - selector = undefined; - } - for ( type in types ) { - this.on( type, selector, data, types[ type ], one ); - } - return this; - } - - if ( data == null && fn == null ) { - // ( types, fn ) - fn = selector; - data = selector = undefined; - } else if ( fn == null ) { - if ( typeof selector === "string" ) { - // ( types, selector, fn ) - fn = data; - data = undefined; - } else { - // ( types, data, fn ) - fn = data; - data = selector; - selector = undefined; - } - } - if ( fn === false ) { - fn = returnFalse; - } else if ( !fn ) { - return this; - } - - if ( one === 1 ) { - origFn = fn; - fn = function( event ) { - // Can use an empty set, since event contains the info - jQuery().off( event ); - return origFn.apply( this, arguments ); - }; - // Use same guid so caller can remove using origFn - fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); - } - return this.each( function() { - jQuery.event.add( this, types, fn, data, selector ); - }); - }, - one: function( types, selector, data, fn ) { - return this.on( types, selector, data, fn, 1 ); - }, - off: function( types, selector, fn ) { - var handleObj, type; - if ( types && types.preventDefault && types.handleObj ) { - // ( event ) dispatched jQuery.Event - handleObj = types.handleObj; - jQuery( types.delegateTarget ).off( - handleObj.namespace ? handleObj.origType + "." + handleObj.namespace : handleObj.origType, - handleObj.selector, - handleObj.handler - ); - return this; - } - if ( typeof types === "object" ) { - // ( types-object [, selector] ) - for ( type in types ) { - this.off( type, selector, types[ type ] ); - } - return this; - } - if ( selector === false || typeof selector === "function" ) { - // ( types [, fn] ) - fn = selector; - selector = undefined; - } - if ( fn === false ) { - fn = returnFalse; - } - return this.each(function() { - jQuery.event.remove( this, types, fn, selector ); - }); - }, - - trigger: function( type, data ) { - return this.each(function() { - jQuery.event.trigger( type, data, this ); - }); - }, - triggerHandler: function( type, data ) { - var elem = this[0]; - if ( elem ) { - return jQuery.event.trigger( type, data, elem, true ); - } - } -}); - - -var - rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi, - rtagName = /<([\w:]+)/, - rhtml = /<|&#?\w+;/, - rnoInnerhtml = /<(?:script|style|link)/i, - // checked="checked" or checked - rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i, - rscriptType = /^$|\/(?:java|ecma)script/i, - rscriptTypeMasked = /^true\/(.*)/, - rcleanScript = /^\s*\s*$/g, - - // We have to close these tags to support XHTML (#13200) - wrapMap = { - - // Support: IE 9 - option: [ 1, "" ], - - thead: [ 1, "", "
" ], - col: [ 2, "", "
" ], - tr: [ 2, "", "
" ], - td: [ 3, "", "
" ], - - _default: [ 0, "", "" ] - }; - -// Support: IE 9 -wrapMap.optgroup = wrapMap.option; - -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - -// Support: 1.x compatibility -// Manipulating tables requires a tbody -function manipulationTarget( elem, content ) { - return jQuery.nodeName( elem, "table" ) && - jQuery.nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ? - - elem.getElementsByTagName("tbody")[0] || - elem.appendChild( elem.ownerDocument.createElement("tbody") ) : - elem; -} - -// Replace/restore the type attribute of script elements for safe DOM manipulation -function disableScript( elem ) { - elem.type = (elem.getAttribute("type") !== null) + "/" + elem.type; - return elem; -} -function restoreScript( elem ) { - var match = rscriptTypeMasked.exec( elem.type ); - - if ( match ) { - elem.type = match[ 1 ]; - } else { - elem.removeAttribute("type"); - } - - return elem; -} - -// Mark scripts as having already been evaluated -function setGlobalEval( elems, refElements ) { - var i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - data_priv.set( - elems[ i ], "globalEval", !refElements || data_priv.get( refElements[ i ], "globalEval" ) - ); - } -} - -function cloneCopyEvent( src, dest ) { - var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; - - if ( dest.nodeType !== 1 ) { - return; - } - - // 1. Copy private data: events, handlers, etc. - if ( data_priv.hasData( src ) ) { - pdataOld = data_priv.access( src ); - pdataCur = data_priv.set( dest, pdataOld ); - events = pdataOld.events; - - if ( events ) { - delete pdataCur.handle; - pdataCur.events = {}; - - for ( type in events ) { - for ( i = 0, l = events[ type ].length; i < l; i++ ) { - jQuery.event.add( dest, type, events[ type ][ i ] ); - } - } - } - } - - // 2. Copy user data - if ( data_user.hasData( src ) ) { - udataOld = data_user.access( src ); - udataCur = jQuery.extend( {}, udataOld ); - - data_user.set( dest, udataCur ); - } -} - -function getAll( context, tag ) { - var ret = context.getElementsByTagName ? context.getElementsByTagName( tag || "*" ) : - context.querySelectorAll ? context.querySelectorAll( tag || "*" ) : - []; - - return tag === undefined || tag && jQuery.nodeName( context, tag ) ? - jQuery.merge( [ context ], ret ) : - ret; -} - -// Support: IE >= 9 -function fixInput( src, dest ) { - var nodeName = dest.nodeName.toLowerCase(); - - // Fails to persist the checked state of a cloned checkbox or radio button. - if ( nodeName === "input" && rcheckableType.test( src.type ) ) { - dest.checked = src.checked; - - // Fails to return the selected option to the default selected state when cloning options - } else if ( nodeName === "input" || nodeName === "textarea" ) { - dest.defaultValue = src.defaultValue; - } -} - -jQuery.extend({ - clone: function( elem, dataAndEvents, deepDataAndEvents ) { - var i, l, srcElements, destElements, - clone = elem.cloneNode( true ), - inPage = jQuery.contains( elem.ownerDocument, elem ); - - // Support: IE >= 9 - // Fix Cloning issues - if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && - !jQuery.isXMLDoc( elem ) ) { - - // We eschew Sizzle here for performance reasons: http://jsperf.com/getall-vs-sizzle/2 - destElements = getAll( clone ); - srcElements = getAll( elem ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - fixInput( srcElements[ i ], destElements[ i ] ); - } - } - - // Copy the events from the original to the clone - if ( dataAndEvents ) { - if ( deepDataAndEvents ) { - srcElements = srcElements || getAll( elem ); - destElements = destElements || getAll( clone ); - - for ( i = 0, l = srcElements.length; i < l; i++ ) { - cloneCopyEvent( srcElements[ i ], destElements[ i ] ); - } - } else { - cloneCopyEvent( elem, clone ); - } - } - - // Preserve script evaluation history - destElements = getAll( clone, "script" ); - if ( destElements.length > 0 ) { - setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); - } - - // Return the cloned set - return clone; - }, - - buildFragment: function( elems, context, scripts, selection ) { - var elem, tmp, tag, wrap, contains, j, - fragment = context.createDocumentFragment(), - nodes = [], - i = 0, - l = elems.length; - - for ( ; i < l; i++ ) { - elem = elems[ i ]; - - if ( elem || elem === 0 ) { - - // Add nodes directly - if ( jQuery.type( elem ) === "object" ) { - // Support: QtWebKit - // jQuery.merge because push.apply(_, arraylike) throws - jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); - - // Convert non-html into a text node - } else if ( !rhtml.test( elem ) ) { - nodes.push( context.createTextNode( elem ) ); - - // Convert html into DOM nodes - } else { - tmp = tmp || fragment.appendChild( context.createElement("div") ); - - // Deserialize a standard representation - tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); - wrap = wrapMap[ tag ] || wrapMap._default; - tmp.innerHTML = wrap[ 1 ] + elem.replace( rxhtmlTag, "<$1>" ) + wrap[ 2 ]; - - // Descend through wrappers to the right content - j = wrap[ 0 ]; - while ( j-- ) { - tmp = tmp.lastChild; - } - - // Support: QtWebKit - // jQuery.merge because push.apply(_, arraylike) throws - jQuery.merge( nodes, tmp.childNodes ); - - // Remember the top-level container - tmp = fragment.firstChild; - - // Fixes #12346 - // Support: Webkit, IE - tmp.textContent = ""; - } - } - } - - // Remove wrapper from fragment - fragment.textContent = ""; - - i = 0; - while ( (elem = nodes[ i++ ]) ) { - - // #4087 - If origin and destination elements are the same, and this is - // that element, do not do anything - if ( selection && jQuery.inArray( elem, selection ) !== -1 ) { - continue; - } - - contains = jQuery.contains( elem.ownerDocument, elem ); - - // Append to fragment - tmp = getAll( fragment.appendChild( elem ), "script" ); - - // Preserve script evaluation history - if ( contains ) { - setGlobalEval( tmp ); - } - - // Capture executables - if ( scripts ) { - j = 0; - while ( (elem = tmp[ j++ ]) ) { - if ( rscriptType.test( elem.type || "" ) ) { - scripts.push( elem ); - } - } - } - } - - return fragment; - }, - - cleanData: function( elems ) { - var data, elem, type, key, - special = jQuery.event.special, - i = 0; - - for ( ; (elem = elems[ i ]) !== undefined; i++ ) { - if ( jQuery.acceptData( elem ) ) { - key = elem[ data_priv.expando ]; - - if ( key && (data = data_priv.cache[ key ]) ) { - if ( data.events ) { - for ( type in data.events ) { - if ( special[ type ] ) { - jQuery.event.remove( elem, type ); - - // This is a shortcut to avoid jQuery.event.remove's overhead - } else { - jQuery.removeEvent( elem, type, data.handle ); - } - } - } - if ( data_priv.cache[ key ] ) { - // Discard any remaining `private` data - delete data_priv.cache[ key ]; - } - } - } - // Discard any remaining `user` data - delete data_user.cache[ elem[ data_user.expando ] ]; - } - } -}); - -jQuery.fn.extend({ - text: function( value ) { - return access( this, function( value ) { - return value === undefined ? - jQuery.text( this ) : - this.empty().each(function() { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - this.textContent = value; - } - }); - }, null, value, arguments.length ); - }, - - append: function() { - return this.domManip( arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.appendChild( elem ); - } - }); - }, - - prepend: function() { - return this.domManip( arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.insertBefore( elem, target.firstChild ); - } - }); - }, - - before: function() { - return this.domManip( arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this ); - } - }); - }, - - after: function() { - return this.domManip( arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this.nextSibling ); - } - }); - }, - - remove: function( selector, keepData /* Internal Use Only */ ) { - var elem, - elems = selector ? jQuery.filter( selector, this ) : this, - i = 0; - - for ( ; (elem = elems[i]) != null; i++ ) { - if ( !keepData && elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem ) ); - } - - if ( elem.parentNode ) { - if ( keepData && jQuery.contains( elem.ownerDocument, elem ) ) { - setGlobalEval( getAll( elem, "script" ) ); - } - elem.parentNode.removeChild( elem ); - } - } - - return this; - }, - - empty: function() { - var elem, - i = 0; - - for ( ; (elem = this[i]) != null; i++ ) { - if ( elem.nodeType === 1 ) { - - // Prevent memory leaks - jQuery.cleanData( getAll( elem, false ) ); - - // Remove any remaining nodes - elem.textContent = ""; - } - } - - return this; - }, - - clone: function( dataAndEvents, deepDataAndEvents ) { - dataAndEvents = dataAndEvents == null ? false : dataAndEvents; - deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; - - return this.map(function() { - return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); - }); - }, - - html: function( value ) { - return access( this, function( value ) { - var elem = this[ 0 ] || {}, - i = 0, - l = this.length; - - if ( value === undefined && elem.nodeType === 1 ) { - return elem.innerHTML; - } - - // See if we can take a shortcut and just use innerHTML - if ( typeof value === "string" && !rnoInnerhtml.test( value ) && - !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { - - value = value.replace( rxhtmlTag, "<$1>" ); - - try { - for ( ; i < l; i++ ) { - elem = this[ i ] || {}; - - // Remove element nodes and prevent memory leaks - if ( elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem, false ) ); - elem.innerHTML = value; - } - } - - elem = 0; - - // If using innerHTML throws an exception, use the fallback method - } catch( e ) {} - } - - if ( elem ) { - this.empty().append( value ); - } - }, null, value, arguments.length ); - }, - - replaceWith: function() { - var arg = arguments[ 0 ]; - - // Make the changes, replacing each context element with the new content - this.domManip( arguments, function( elem ) { - arg = this.parentNode; - - jQuery.cleanData( getAll( this ) ); - - if ( arg ) { - arg.replaceChild( elem, this ); - } - }); - - // Force removal if there was no new content (e.g., from empty arguments) - return arg && (arg.length || arg.nodeType) ? this : this.remove(); - }, - - detach: function( selector ) { - return this.remove( selector, true ); - }, - - domManip: function( args, callback ) { - - // Flatten any nested arrays - args = concat.apply( [], args ); - - var fragment, first, scripts, hasScripts, node, doc, - i = 0, - l = this.length, - set = this, - iNoClone = l - 1, - value = args[ 0 ], - isFunction = jQuery.isFunction( value ); - - // We can't cloneNode fragments that contain checked, in WebKit - if ( isFunction || - ( l > 1 && typeof value === "string" && - !support.checkClone && rchecked.test( value ) ) ) { - return this.each(function( index ) { - var self = set.eq( index ); - if ( isFunction ) { - args[ 0 ] = value.call( this, index, self.html() ); - } - self.domManip( args, callback ); - }); - } - - if ( l ) { - fragment = jQuery.buildFragment( args, this[ 0 ].ownerDocument, false, this ); - first = fragment.firstChild; - - if ( fragment.childNodes.length === 1 ) { - fragment = first; - } - - if ( first ) { - scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); - hasScripts = scripts.length; - - // Use the original fragment for the last item instead of the first because it can end up - // being emptied incorrectly in certain situations (#8070). - for ( ; i < l; i++ ) { - node = fragment; - - if ( i !== iNoClone ) { - node = jQuery.clone( node, true, true ); - - // Keep references to cloned scripts for later restoration - if ( hasScripts ) { - // Support: QtWebKit - // jQuery.merge because push.apply(_, arraylike) throws - jQuery.merge( scripts, getAll( node, "script" ) ); - } - } - - callback.call( this[ i ], node, i ); - } - - if ( hasScripts ) { - doc = scripts[ scripts.length - 1 ].ownerDocument; - - // Reenable scripts - jQuery.map( scripts, restoreScript ); - - // Evaluate executable scripts on first document insertion - for ( i = 0; i < hasScripts; i++ ) { - node = scripts[ i ]; - if ( rscriptType.test( node.type || "" ) && - !data_priv.access( node, "globalEval" ) && jQuery.contains( doc, node ) ) { - - if ( node.src ) { - // Optional AJAX dependency, but won't run scripts if not present - if ( jQuery._evalUrl ) { - jQuery._evalUrl( node.src ); - } - } else { - jQuery.globalEval( node.textContent.replace( rcleanScript, "" ) ); - } - } - } - } - } - } - - return this; - } -}); - -jQuery.each({ - appendTo: "append", - prependTo: "prepend", - insertBefore: "before", - insertAfter: "after", - replaceAll: "replaceWith" -}, function( name, original ) { - jQuery.fn[ name ] = function( selector ) { - var elems, - ret = [], - insert = jQuery( selector ), - last = insert.length - 1, - i = 0; - - for ( ; i <= last; i++ ) { - elems = i === last ? this : this.clone( true ); - jQuery( insert[ i ] )[ original ]( elems ); - - // Support: QtWebKit - // .get() because push.apply(_, arraylike) throws - push.apply( ret, elems.get() ); - } - - return this.pushStack( ret ); - }; -}); - - -var iframe, - elemdisplay = {}; - -/** - * Retrieve the actual display of a element - * @param {String} name nodeName of the element - * @param {Object} doc Document object - */ -// Called only from within defaultDisplay -function actualDisplay( name, doc ) { - var style, - elem = jQuery( doc.createElement( name ) ).appendTo( doc.body ), - - // getDefaultComputedStyle might be reliably used only on attached element - display = window.getDefaultComputedStyle && ( style = window.getDefaultComputedStyle( elem[ 0 ] ) ) ? - - // Use of this method is a temporary fix (more like optmization) until something better comes along, - // since it was removed from specification and supported only in FF - style.display : jQuery.css( elem[ 0 ], "display" ); - - // We don't have any data stored on the element, - // so use "detach" method as fast way to get rid of the element - elem.detach(); - - return display; -} - -/** - * Try to determine the default display value of an element - * @param {String} nodeName - */ -function defaultDisplay( nodeName ) { - var doc = document, - display = elemdisplay[ nodeName ]; - - if ( !display ) { - display = actualDisplay( nodeName, doc ); - - // If the simple way fails, read from inside an iframe - if ( display === "none" || !display ) { - - // Use the already-created iframe if possible - iframe = (iframe || jQuery( "