├── src ├── utils │ ├── footer.js │ ├── shortenString.js │ ├── header.js │ ├── redform.js │ ├── fontawesome.js │ ├── breakpoints.js │ ├── viewport.js │ └── swiper.js ├── scss │ ├── utils │ │ ├── _mixin.scss │ │ ├── _variables.scss │ │ └── _bootstrap.scss │ └── layouts │ │ ├── _footer.scss │ │ └── _header.scss ├── favicon │ ├── favicon.png │ └── favicon.json ├── fonts │ ├── Inter-Medium.ttf │ ├── OpenSans-Bold.ttf │ ├── OpenSans-Regular.ttf │ ├── OpenSans-SemiBold.ttf │ └── fontface.scss ├── components │ └── Toast.js ├── entry │ ├── app.js │ └── app.scss └── provider │ └── index.js ├── template ├── html │ ├── index.html │ ├── com_users │ │ └── login │ │ │ └── default_login.php │ └── layouts │ │ └── oauth2 │ │ └── authorize.php ├── template_preview.png ├── template_thumbnail.png ├── component.php ├── templateDetails.xml ├── index.php └── helper.php ├── README.md ├── composer.json ├── webpack.config.js ├── jsconfig.json ├── postcss.config.js ├── .babelrc ├── .prettierrc ├── sample.env ├── .github ├── workflows │ ├── format.yml │ ├── deploy.yml │ └── develop.yml └── dependabot.yml ├── .gitignore ├── package.json ├── composer.lock ├── webpack.common.js ├── webpack.template.js └── LICENSE /src/utils/footer.js: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/scss/utils/_mixin.scss: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /template/html/index.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/scss/layouts/_footer.scss: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AesirX SSO Joomla template 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /src/favicon/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aesirxio/sso-template/HEAD/src/favicon/favicon.png -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "require": { 3 | "mobiledetect/mobiledetectlib": "^3.74" 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | var template = require("./webpack.template.js"); 2 | 3 | module.exports = [template]; 4 | -------------------------------------------------------------------------------- /src/fonts/Inter-Medium.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aesirxio/sso-template/HEAD/src/fonts/Inter-Medium.ttf -------------------------------------------------------------------------------- /src/fonts/OpenSans-Bold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aesirxio/sso-template/HEAD/src/fonts/OpenSans-Bold.ttf -------------------------------------------------------------------------------- /jsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "baseUrl": "src" 4 | }, 5 | "include": ["src"] 6 | } -------------------------------------------------------------------------------- /src/fonts/OpenSans-Regular.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aesirxio/sso-template/HEAD/src/fonts/OpenSans-Regular.ttf -------------------------------------------------------------------------------- /template/template_preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aesirxio/sso-template/HEAD/template/template_preview.png -------------------------------------------------------------------------------- /src/fonts/OpenSans-SemiBold.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aesirxio/sso-template/HEAD/src/fonts/OpenSans-SemiBold.ttf -------------------------------------------------------------------------------- /template/template_thumbnail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/aesirxio/sso-template/HEAD/template/template_thumbnail.png -------------------------------------------------------------------------------- /postcss.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | plugins: [ 3 | require("autoprefixer"), 4 | require("cssnano")({ 5 | preset: "default", 6 | }), 7 | ], 8 | }; 9 | -------------------------------------------------------------------------------- /src/utils/shortenString.js: -------------------------------------------------------------------------------- 1 | const shortenString = (str) => { 2 | return str.substring(0, 6) + '...' + str.substring(str.length - 4); 3 | }; 4 | export { shortenString }; 5 | -------------------------------------------------------------------------------- /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | "@babel/preset-env", 4 | ["@babel/preset-react", {"runtime": "automatic"}] 5 | ], 6 | "plugins": [ 7 | "syntax-dynamic-import" 8 | ] 9 | } -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "arrowParens": "always", 3 | "bracketSpacing": true, 4 | "trailingComma": "es5", 5 | "tabWidth": 2, 6 | "semi": true, 7 | "singleQuote": true, 8 | "printWidth": 100 9 | } 10 | -------------------------------------------------------------------------------- /src/utils/header.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | -------------------------------------------------------------------------------- /sample.env: -------------------------------------------------------------------------------- 1 | wwwDir=/Users/name/webserver/www 2 | projectname=sso 3 | host=intern.redweb.dk 4 | username=sso 5 | password=sso 6 | remotePath=/home/sso/public_html 7 | port=4975 8 | dbhost=localhost 9 | dbname=sso 10 | dbusername=sso 11 | dbpassword=sso -------------------------------------------------------------------------------- /src/scss/layouts/_header.scss: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | -------------------------------------------------------------------------------- /src/utils/redform.js: -------------------------------------------------------------------------------- 1 | export function redFormSubmit(element) { 2 | var btnSubmit = document.querySelector(element); 3 | if (btnSubmit) { 4 | btnSubmit.addEventListener('click', function () { 5 | btnSubmit.querySelector('input').click(); 6 | }); 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/utils/fontawesome.js: -------------------------------------------------------------------------------- 1 | import { icon } from '@fortawesome/fontawesome-svg-core'; 2 | export function fontAwesomeLoad(element, elementIcon) { 3 | let list = document.querySelectorAll(element); 4 | if (list) { 5 | list.forEach(function (item, index) { 6 | item.prepend(icon(elementIcon).node[0]); 7 | }); 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /.github/workflows/format.yml: -------------------------------------------------------------------------------- 1 | name: Format 2 | 3 | on: 4 | pull_request: 5 | 6 | jobs: 7 | code: 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v3 12 | - uses: actions/setup-node@v3 13 | with: 14 | node-version: 16.x 15 | 16 | - name: Install dependencies 17 | run: yarn install 18 | 19 | - name: Run Prettier 20 | run: yarn run format:check -------------------------------------------------------------------------------- /src/utils/breakpoints.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | 9 | module.exports = { 10 | mobile: { 11 | xs: 0, 12 | }, 13 | tablet: { 14 | sm: '576px', 15 | md: '768px', 16 | }, 17 | desktop: { 18 | lg: '992px', 19 | xl: '1200px', 20 | xxl: '1400px', 21 | }, 22 | }; 23 | -------------------------------------------------------------------------------- /src/scss/utils/_variables.scss: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | $success: #1ab394; 9 | $danger: #C60202; 10 | $primary: #0A083B !default; 11 | $form-check-input-checked-color: #fff; 12 | $secondary: #4486ab; 13 | $border-color: #dedede; 14 | 15 | $font-family-base: 'Open Sans', sans-serif !default; 16 | 17 | $enable-dark-mode: false !default; -------------------------------------------------------------------------------- /src/components/Toast.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { ToastContainer } from 'react-toastify'; 3 | import 'react-toastify/dist/ReactToastify.css'; 4 | 5 | const ToastComponent = () => { 6 | return ( 7 | 19 | ); 20 | }; 21 | 22 | export default ToastComponent; 23 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # Basic set up for three package managers 2 | 3 | version: 2 4 | updates: 5 | 6 | # Maintain dependencies for GitHub Actions 7 | - package-ecosystem: "github-actions" 8 | directory: "/" 9 | schedule: 10 | interval: "monthly" 11 | 12 | # Maintain dependencies for npm 13 | - package-ecosystem: "npm" 14 | directory: "/" 15 | schedule: 16 | interval: "monthly" 17 | 18 | # Maintain dependencies for Composer 19 | - package-ecosystem: "composer" 20 | directory: "/" 21 | schedule: 22 | interval: "monthly" 23 | -------------------------------------------------------------------------------- /src/entry/app.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | import './app.scss'; 9 | 10 | import React from 'react'; 11 | import ProviderLogin from '../provider'; 12 | import { createRoot } from 'react-dom/client'; 13 | const container = document.getElementById('providerlogin'); 14 | const root = createRoot(container); // createRoot(container!) if you use TypeScript 15 | root.render(); 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # OSX 2 | .DS_Store 3 | ._* 4 | .Spotlight-V100 5 | .Trashes 6 | 7 | # Windows 8 | Thumbs.db 9 | Desktop.ini 10 | 11 | # PHPStorm 12 | .idea/ 13 | 14 | # Sublime Text 15 | *.sublime* 16 | sftp-config.json 17 | 18 | # Eclipse 19 | .buildpath 20 | .project 21 | .settings 22 | 23 | # Netbeans (custom) 24 | .netbeans/* 25 | 26 | # Temp files 27 | *.tmp 28 | *.bak 29 | *.swp 30 | *~.nib 31 | *~ 32 | *.bak.php 33 | 34 | # composer 35 | composer.phar 36 | vendor/* 37 | **/vendor/* 38 | 39 | # Never ignore 40 | !.gitkeep 41 | !.gitignore 42 | !index.html 43 | !index.php 44 | 45 | # Build config 46 | gulp-config.json 47 | node_modules 48 | releases 49 | 50 | # Build files 51 | dist/* 52 | 53 | .env 54 | *.code-workspace 55 | yarn-error.log 56 | .yalc 57 | yalc.lock -------------------------------------------------------------------------------- /template/component.php: -------------------------------------------------------------------------------- 1 | template . '/helper.php'; 12 | 13 | tplRedwebHelper::setMetadata(); 14 | 15 | ?> 16 | 17 | 18 | 19 | 20 | <%= htmlWebpackPlugin.tags.headTags %> 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | <%= htmlWebpackPlugin.tags.bodyTags %> 29 | 30 | 31 | -------------------------------------------------------------------------------- /src/utils/viewport.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | 9 | const breakpoints = require('./breakpoints.js'); 10 | 11 | export var viewport = 'mobile'; 12 | 13 | Object.keys(breakpoints).map(function (screen) { 14 | Object.keys(breakpoints[screen]).map(function (breakpoint) { 15 | if (window.innerWidth > parseInt(breakpoints[screen][breakpoint])) { 16 | viewport = screen; 17 | } 18 | }); 19 | }); 20 | 21 | export function loadStyle(name) { 22 | if (joomlaOptions[name + '-' + viewport + '.css']) { 23 | var body = document.querySelector('body'); 24 | 25 | var style = document.createElement('link'); 26 | style.href = joomlaOptions[name + '-' + viewport + '.css']; 27 | style.type = 'text/css'; 28 | style.rel = 'stylesheet'; 29 | body.append(style); 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /src/fonts/fontface.scss: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | 9 | @font-face { 10 | font-family: "Open Sans"; 11 | src: url("../fonts/OpenSans-Regular.ttf") format("truetype"); 12 | font-weight: 400; 13 | font-style: normal; 14 | font-display: swap; 15 | } 16 | 17 | @font-face { 18 | font-family: "Open Sans"; 19 | src: url("../fonts/OpenSans-SemiBold.ttf") format("truetype"); 20 | font-weight: 600; 21 | font-style: normal; 22 | font-display: swap; 23 | } 24 | 25 | @font-face { 26 | font-family: "Inter"; 27 | src: url("../fonts/OpenSans-Bold.ttf") format("truetype"); 28 | font-weight: bold; 29 | font-style: normal; 30 | font-display: swap; 31 | } 32 | 33 | @font-face { 34 | font-family: "Inter"; 35 | src: url("../fonts/Inter-Medium.ttf") format("truetype"); 36 | font-weight: 500; 37 | font-style: normal; 38 | font-display: swap; 39 | } -------------------------------------------------------------------------------- /.github/workflows/deploy.yml: -------------------------------------------------------------------------------- 1 | name: deploy 2 | on: 3 | push: 4 | branches: 5 | - master 6 | 7 | jobs: 8 | build-and-deploy: 9 | runs-on: ubuntu-latest 10 | environment: deploy 11 | env: 12 | CI: false 13 | REACT_APP_CONCORDIUM_NETWORK: ${{ secrets.REACT_APP_CONCORDIUM_NETWORK }} 14 | steps: 15 | - uses: actions/checkout@v3 16 | - uses: actions/setup-node@v3 17 | with: 18 | node-version: 16 19 | 20 | - uses: php-actions/composer@v6 21 | 22 | - name: Install SSH Key 23 | uses: shimataro/ssh-key-action@v2 24 | with: 25 | key: ${{ secrets.SSH_PRIVATE_KEY }} 26 | known_hosts: unnecessary 27 | 28 | - name: Adding Known Hosts 29 | run: ssh-keyscan -p ${{ secrets.SSH_PORT}} -H ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts 30 | 31 | - run: yarn install 32 | - run: yarn run release 33 | 34 | - name: Deploy with rsync 35 | run: rsync -avz -e "ssh -p ${{ secrets.SSH_PORT }}" ./dist/templates/sso/ ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }}:${{ secrets.SSH_PATH }} 36 | -------------------------------------------------------------------------------- /src/provider/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { SSOButton } from 'aesirx-sso'; 3 | import queryString from 'query-string'; 4 | import { Buffer } from 'buffer'; 5 | 6 | const withHttp = (url) => (!/^https?:\/\//i.test(url) ? `https://${url}` : url); 7 | 8 | const ProviderLogin = () => { 9 | const onGetData = async (response) => { 10 | if (response.error) { 11 | notify(response.error_description, 'error'); 12 | } else { 13 | if (response?.return) { 14 | const decoded = Buffer.from(response?.return, 'base64').toString(); 15 | window.location.href = `${withHttp(decoded)}`; 16 | } else if (response?.recirect_uri) { 17 | window.location.href = `${withHttp( 18 | data?.result?.recirect_uri 19 | )}?state=sso&${queryString.stringify(data.result)}&lastVisitDate=0`; 20 | } else { 21 | window.location.href = '/'; 22 | } 23 | } 24 | }; 25 | 26 | return ( 27 | <> 28 | 33 | 34 | ); 35 | }; 36 | 37 | export default ProviderLogin; 38 | -------------------------------------------------------------------------------- /template/html/com_users/login/default_login.php: -------------------------------------------------------------------------------- 1 | get("themeParams"); 19 | $logo = $params->get('logo'); 20 | ?> 21 |
22 |

23 | Welcome to 24 |
Sign in to get started. 25 |

26 | 36 |
37 | -------------------------------------------------------------------------------- /.github/workflows/develop.yml: -------------------------------------------------------------------------------- 1 | name: develop 2 | on: 3 | push: 4 | branches: 5 | - develop 6 | 7 | jobs: 8 | build-and-deploy: 9 | runs-on: ubuntu-latest 10 | environment: develop 11 | env: 12 | CI: false 13 | REACT_APP_SSO_CONCORDIUM_NETWORK: ${{ secrets.REACT_APP_SSO_CONCORDIUM_NETWORK }} 14 | REACT_APP_ENDPOINT_URL: ${{ secrets.REACT_APP_ENDPOINT_URL }} 15 | REACT_APP_SSO_CLIENT_ID: ${{ secrets.REACT_APP_SSO_CLIENT_ID }} 16 | REACT_APP_SSO_CLIENT_SECRET: ${{ secrets.REACT_APP_SSO_CLIENT_SECRET }} 17 | steps: 18 | - uses: actions/checkout@v3 19 | - uses: actions/setup-node@v3 20 | with: 21 | node-version: 16 22 | 23 | - uses: php-actions/composer@v6 24 | 25 | - name: Install SSH Key 26 | uses: shimataro/ssh-key-action@v2 27 | with: 28 | key: ${{ secrets.SSH_PRIVATE_KEY }} 29 | known_hosts: unnecessary 30 | 31 | - name: Adding Known Hosts 32 | run: ssh-keyscan -p ${{ secrets.SSH_PORT}} -H ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts 33 | 34 | - run: yarn install 35 | - run: yarn run deploy 36 | 37 | - name: Deploy with rsync 38 | run: rsync -avz -e "ssh -p ${{ secrets.SSH_PORT }}" ./dist/templates/sso/ ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }}:${{ secrets.SSH_PATH }} 39 | -------------------------------------------------------------------------------- /src/favicon/favicon.json: -------------------------------------------------------------------------------- 1 | { 2 | "design": { 3 | "ios": { 4 | "pictureAspect": "noChange", 5 | "assets": { 6 | "ios6AndPriorIcons": false, 7 | "ios7AndLaterIcons": false, 8 | "precomposedIcons": false, 9 | "declareOnlyDefaultIcon": true 10 | } 11 | }, 12 | "desktopBrowser": { 13 | "design": "raw" 14 | }, 15 | "windows": { 16 | "pictureAspect": "noChange", 17 | "backgroundColor": "#ffffff", 18 | "onConflict": "override", 19 | "assets": { 20 | "windows80Ie10Tile": false, 21 | "windows10Ie11EdgeTiles": { 22 | "small": false, 23 | "medium": true, 24 | "big": false, 25 | "rectangle": false 26 | } 27 | } 28 | }, 29 | "androidChrome": { 30 | "pictureAspect": "noChange", 31 | "themeColor": "#ffffff", 32 | "manifest": { 33 | "display": "standalone", 34 | "orientation": "notSet", 35 | "onConflict": "override", 36 | "declared": true 37 | }, 38 | "assets": { 39 | "legacyIcon": false, 40 | "lowResolutionIcons": false 41 | } 42 | }, 43 | "safariPinnedTab": { 44 | "pictureAspect": "blackAndWhite", 45 | "themeColor": "#5bbad5" 46 | } 47 | }, 48 | "settings": { 49 | "scalingAlgorithm": "Mitchell", 50 | "errorOnImageTooSmall": false, 51 | "readmeFile": false, 52 | "htmlCodeFile": false, 53 | "usePathAsIs": false 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /src/scss/utils/_bootstrap.scss: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | 9 | @import '~bootstrap/scss/functions'; 10 | @import './variables'; 11 | @import './mixin'; 12 | @import '~bootstrap/scss/variables'; 13 | @import '~bootstrap/scss/mixins'; 14 | @import '~bootstrap/scss/maps'; 15 | @import '~bootstrap/scss/utilities'; 16 | @import '~bootstrap/scss/spinners'; 17 | 18 | //customize Class 19 | $utilities: map-merge( 20 | $utilities, 21 | ( 22 | 'z': ( 23 | property: z-index, 24 | class: z, 25 | values: ( 26 | n1: -1, 27 | 0: 0, 28 | 1: 9, 29 | 2: 99, 30 | 3: 999, 31 | 4: 9999, 32 | ), 33 | ), 34 | 'font-family': ( 35 | property: font-family, 36 | class: font, 37 | values: ( 38 | inter: 'Inter', 39 | ), 40 | ), 41 | 'object': ( 42 | property: object-fit, 43 | class: ob, 44 | values: ( 45 | 'cover': cover, 46 | 'contain': contain, 47 | ), 48 | ), 49 | 'font-weight': ( 50 | property: font-weight, 51 | class: fw, 52 | values: ( 53 | light: $font-weight-light, 54 | lighter: $font-weight-lighter, 55 | normal: $font-weight-normal, 56 | medium: 500, 57 | semibold: 600, 58 | bold: $font-weight-bold, 59 | bolder: $font-weight-bolder, 60 | ), 61 | ), 62 | ) 63 | ); 64 | 65 | // Utilities 66 | @import '~bootstrap/scss/utilities/api'; 67 | -------------------------------------------------------------------------------- /template/templateDetails.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | <%= projectname %> 5 | Sep 2022 6 | AesirX 7 | support@r-digital.tech 8 | https://r-digital.tech/ 9 | Copyright (C) 2005 - 2022 Open Source Matters, Inc. All rights reserved. 10 | GNU General Public License version 2 or later; see LICENSE.txt 11 | 1.1.0 12 | SSO AesirX Template 13 | 14 | 15 | css 16 | favicon 17 | html 18 | images 19 | js 20 | vendor 21 | assets-manifest.json 22 | component.php 23 | helper.php 24 | index.php 25 | templateDetails.xml 26 | template_preview.png 27 | template_thumbnail.png 28 | 29 | 30 | 31 | debug 32 | header 33 | logo 34 | top-right 35 | main-menu 36 | above-content 37 | below-content 38 | above-main 39 | below-main 40 | footer 41 | copyright 42 | modal 43 | search 44 | 45 | 46 | 47 |
48 | 54 |
55 |
56 |
57 |
-------------------------------------------------------------------------------- /template/html/layouts/oauth2/authorize.php: -------------------------------------------------------------------------------- 1 | get('sitename', 'API'); 17 | $scopes = !empty($displayData['options']['scopes']) ? $displayData['options']['scopes'] : array(); 18 | $column = 0; 19 | 20 | ?> 21 | 22 | 23 | 24 | 25 | 26 | 27 | <%= htmlWebpackPlugin.tags.headTags %> 28 | 29 | 30 | 31 |
32 |

Welcome to AesirX SSO

33 | 34 |

35 | 36 |

37 |
38 | 44 | 45 |
46 |
47 |
48 | 49 | 50 | 51 | 52 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sso", 3 | "version": "1.0.0", 4 | "description": "Webpack config for Joomla template", 5 | "private": true, 6 | "scripts": { 7 | "build": "webpack --mode=development", 8 | "release": "webpack --mode=production --env deploy=true", 9 | "watch": "webpack --watch --mode=development", 10 | "deploy": "webpack --mode=development --env deploy=true", 11 | "test": "echo \"Error: no test specified\" && exit 1", 12 | "format:check": "prettier --check 'src/**/*.{js,jsx,ts,tsx}'", 13 | "format:write": "prettier --write 'src/**/*.{js,jsx,ts,tsx}'" 14 | }, 15 | "keywords": [], 16 | "author": "AesirX", 17 | "license": "GPL-3.0-only", 18 | "dependencies": { 19 | "aesirx-sso": "^1.2.3", 20 | "bootstrap": "^5.3.0", 21 | "buffer": "^6.0.3", 22 | "query-string": "7", 23 | "react": "^18.2.0", 24 | "react-dom": "^18.2.0", 25 | "react-toastify": "^9.1.2" 26 | }, 27 | "devDependencies": { 28 | "@babel/core": "^7.21.0", 29 | "@babel/preset-env": "^7.21.5", 30 | "@babel/preset-react": "^7.18.6", 31 | "@popperjs/core": "^2.11.6", 32 | "aesirxio-template-library": "git+https://github.com/aesirxio/aesirxio-template-library.git#master", 33 | "autoprefixer": "^10.4.13", 34 | "babel-loader": "^9.1.2", 35 | "babel-plugin-syntax-dynamic-import": "^6.18.0", 36 | "babel-preset-env": "^1.7.0", 37 | "browser-sync": "^2.28.1", 38 | "browser-sync-webpack-plugin": "^2.3.0", 39 | "critical": "^2.0.0", 40 | "critical-css-webpack-plugin": "^3.0.0", 41 | "css-loader": "^6.7.3", 42 | "cssnano": "^6.0.0", 43 | "del": "^7.0.0", 44 | "dotenv": "^16.0.3", 45 | "filemanager-webpack-plugin": "^8.0.0", 46 | "fs": "^0.0.1-security", 47 | "html-webpack-plugin": "^5.5.1", 48 | "media-query-plugin": "^1.5.0", 49 | "mini-css-extract-plugin": "^2.7.2", 50 | "postcss": "^8.4.21", 51 | "postcss-loader": "^7.0.2", 52 | "prettier": "^2.8.4", 53 | "sass": "^1.60.0", 54 | "sass-loader": "^13.2.0", 55 | "style-loader": "^3.3.1", 56 | "url-loader": "^4.1.1", 57 | "webpack": "^5.76.0", 58 | "webpack-assets-manifest": "^5.1.0", 59 | "webpack-cli": "^5.0.1", 60 | "webpack-dev-server": "^4.11.1", 61 | "webpack-font-preload-plugin": "^1.5.0", 62 | "webpack-remove-empty-scripts": "^1.0.1" 63 | }, 64 | "browserslist": [ 65 | "> 1%", 66 | "last 1 version", 67 | "not dead" 68 | ], 69 | "resolutions": { 70 | "nth-check": "^2.0.1" 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /template/index.php: -------------------------------------------------------------------------------- 1 | template . '/helper.php'; 15 | 16 | tplRedwebHelper::setMetadata(); 17 | 18 | ?> 19 | 20 | 21 | 22 | 23 | <%= htmlWebpackPlugin.tags.headTags %> 24 | 25 | 26 | 27 | 38 | 39 |
40 | countModules('above-main')) : ?> 41 | 42 | 43 | 44 | 45 |
46 |
47 | countModules('above-content')) : ?> 48 | 49 | 50 | 51 | 52 | 53 | 54 | countModules('below-content')) : ?> 55 | 56 | 57 |
58 |
59 | 60 | countModules('below-main')) : ?> 61 |
62 | 63 |
64 | 65 | 66 | 67 |
68 | 69 |
70 |
71 | 72 | 73 | 74 | 75 | 76 | 77 | -------------------------------------------------------------------------------- /composer.lock: -------------------------------------------------------------------------------- 1 | { 2 | "_readme": [ 3 | "This file locks the dependencies of your project to a known state", 4 | "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", 5 | "This file is @generated automatically" 6 | ], 7 | "content-hash": "d5b17e3bb2e910a6b1bb7f71ba8ecc54", 8 | "packages": [ 9 | { 10 | "name": "mobiledetect/mobiledetectlib", 11 | "version": "3.74.0", 12 | "source": { 13 | "type": "git", 14 | "url": "https://github.com/serbanghita/Mobile-Detect.git", 15 | "reference": "812a4aa4605c63fc33d7fe32ca82f29275940b9d" 16 | }, 17 | "dist": { 18 | "type": "zip", 19 | "url": "https://api.github.com/repos/serbanghita/Mobile-Detect/zipball/812a4aa4605c63fc33d7fe32ca82f29275940b9d", 20 | "reference": "812a4aa4605c63fc33d7fe32ca82f29275940b9d", 21 | "shasum": "" 22 | }, 23 | "require": { 24 | "php": ">=7.4" 25 | }, 26 | "require-dev": { 27 | "friendsofphp/php-cs-fixer": "v2.19.3", 28 | "phpunit/phpunit": "^7.0.0", 29 | "squizlabs/php_codesniffer": "3.*" 30 | }, 31 | "type": "library", 32 | "autoload": { 33 | "psr-4": { 34 | "Detection\\": "src/" 35 | }, 36 | "classmap": [ 37 | "src/MobileDetect.php" 38 | ] 39 | }, 40 | "notification-url": "https://packagist.org/downloads/", 41 | "license": [ 42 | "MIT" 43 | ], 44 | "authors": [ 45 | { 46 | "name": "Serban Ghita", 47 | "email": "serbanghita@gmail.com", 48 | "homepage": "http://mobiledetect.net", 49 | "role": "Developer" 50 | } 51 | ], 52 | "description": "Mobile_Detect is a lightweight PHP class for detecting mobile devices. It uses the User-Agent string combined with specific HTTP headers to detect the mobile environment.", 53 | "homepage": "https://github.com/serbanghita/Mobile-Detect", 54 | "keywords": [ 55 | "detect mobile devices", 56 | "mobile", 57 | "mobile detect", 58 | "mobile detector", 59 | "php mobile detect" 60 | ], 61 | "support": { 62 | "issues": "https://github.com/serbanghita/Mobile-Detect/issues", 63 | "source": "https://github.com/serbanghita/Mobile-Detect/tree/3.74.0" 64 | }, 65 | "time": "2022-12-04T15:37:32+00:00" 66 | } 67 | ], 68 | "packages-dev": [], 69 | "aliases": [], 70 | "minimum-stability": "stable", 71 | "stability-flags": [], 72 | "prefer-stable": false, 73 | "prefer-lowest": false, 74 | "platform": [], 75 | "platform-dev": [], 76 | "plugin-api-version": "2.3.0" 77 | } 78 | -------------------------------------------------------------------------------- /webpack.common.js: -------------------------------------------------------------------------------- 1 | const MediaQueryPlugin = require('aesirxio-template-library/media-query-plugin'); 2 | const MiniCssExtractPlugin = require('mini-css-extract-plugin'); 3 | 4 | const path = require('path'); 5 | const fs = require('fs'); 6 | const entry = 'src/entry/'; 7 | const wwwDir = path.resolve(__dirname, './dist'); 8 | const projectname = 'sso'; 9 | 10 | const breakpoints = require(__dirname + '/src/utils/breakpoints.js'); 11 | 12 | var queryData = {}; 13 | var breakpointsData = []; 14 | 15 | Object.keys(breakpoints).map(function (screen) { 16 | Object.keys(breakpoints[screen]).map(function (breakpoint) { 17 | queryData['(min-width: ' + breakpoints[screen][breakpoint] + ')'] = screen; 18 | 19 | breakpointsData.push(breakpoint + ':' + breakpoints[screen][breakpoint]); 20 | }); 21 | }); 22 | 23 | const getAllFiles = function (dirPath, arrayOfFiles) { 24 | files = fs.readdirSync(dirPath); 25 | 26 | arrayOfFiles = arrayOfFiles || []; 27 | 28 | files.forEach(function (file) { 29 | if (fs.statSync(dirPath + '/' + file).isDirectory()) { 30 | arrayOfFiles = getAllFiles(dirPath + '/' + file, arrayOfFiles); 31 | } else if (path.extname(file) == '.js' || path.extname(file) == '.scss') { 32 | let fullPath = path.join(dirPath, '/', file); 33 | let fileName = fullPath 34 | .replace(entry, '') 35 | .replace(/\//g, '.') 36 | .replace('.js', '') 37 | .replace('.scss', ''); 38 | 39 | if (arrayOfFiles[fileName]) { 40 | arrayOfFiles[fileName].push(path.resolve(__dirname, fullPath)); 41 | } else { 42 | arrayOfFiles[fileName] = [path.resolve(__dirname, fullPath)]; 43 | } 44 | } 45 | }); 46 | 47 | return arrayOfFiles; 48 | }; 49 | 50 | const entryData = Object.assign({}, getAllFiles(entry)); 51 | 52 | const sassData = { 53 | loader: 'sass-loader', 54 | options: { 55 | additionalData: 56 | ` 57 | $grid-breakpoints: ( 58 | ` + 59 | breakpointsData.join(',').replace(/\'/g, '') + 60 | ` 61 | ) !default; 62 | @import "src/scss/utils/bootstrap";`, 63 | }, 64 | }; 65 | 66 | const sassLoader = { 67 | test: /\.(scss)$/, 68 | use: [ 69 | MiniCssExtractPlugin.loader, 70 | 'css-loader', 71 | MediaQueryPlugin.loader, 72 | 'postcss-loader', 73 | sassData, 74 | ], 75 | }; 76 | 77 | const sassCriticalLoader = { 78 | test: /(app).scss$/, 79 | use: [ 80 | MiniCssExtractPlugin.loader, 81 | 'css-loader', 82 | MediaQueryPlugin.loader, 83 | 'postcss-loader', 84 | sassData, 85 | ], 86 | }; 87 | 88 | const jceSassLoader = { 89 | test: /\.(scss)$/, 90 | use: [ 91 | { 92 | loader: MiniCssExtractPlugin.loader, 93 | options: { 94 | publicPath: '../', 95 | }, 96 | }, 97 | 'css-loader', 98 | 'postcss-loader', 99 | sassData, 100 | ], 101 | }; 102 | 103 | const imageLoader = { 104 | test: /\.(gif|png|jpe?g|svg)$/i, 105 | type: 'asset/resource', 106 | generator: { 107 | filename: 'image/[contenthash][ext][query]', 108 | }, 109 | }; 110 | 111 | const fontLoader = { 112 | test: /\.(woff|woff2|eot|ttf|otf)$/, 113 | type: 'asset/resource', 114 | generator: { 115 | filename: 'fonts/[contenthash][ext][query]', 116 | }, 117 | }; 118 | 119 | const jsLoader = { 120 | test: /\.js$/, 121 | exclude: /node_modules\/(?!(dom7|ssr-window|swiper)\/).*/, 122 | use: { 123 | loader: 'babel-loader', 124 | }, 125 | }; 126 | 127 | const aliasData = { 128 | src: path.resolve(__dirname, './src'), 129 | }; 130 | 131 | const cssLoader = { 132 | test: /\.css$/i, 133 | use: ['style-loader', 'css-loader'], 134 | }; 135 | 136 | module.exports = { 137 | queryData, 138 | entryData, 139 | wwwDir, 140 | projectname, 141 | sassLoader, 142 | sassCriticalLoader, 143 | jceSassLoader, 144 | imageLoader, 145 | fontLoader, 146 | jsLoader, 147 | cssLoader, 148 | aliasData, 149 | }; 150 | -------------------------------------------------------------------------------- /src/utils/swiper.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | import { Swiper, Pagination, Navigation } from 'swiper'; 9 | // configure Swiper to use modules 10 | Swiper.use([Pagination]); 11 | Swiper.use([Navigation]); 12 | import 'swiper/swiper-bundle.css'; 13 | import 'waypoints/lib/noframework.waypoints.min.js'; 14 | // import Swiper JS 15 | 16 | var slider = document.querySelectorAll('.swiper-container'); 17 | slider.forEach(function (slide, index) { 18 | new Waypoint({ 19 | element: document.getElementById(slide.id), 20 | handler: function (direction) { 21 | if (document.getElementById(slide.id).classList.contains('swiper-container-initialized')) { 22 | return; 23 | } 24 | 25 | var slide_effect = slide.dataset.slideEffect, 26 | slide_speed = parseInt(slide.dataset.slideSpeed), 27 | slide_direction = slide.dataset.slideDirection, 28 | slide_number_desktop = slide.dataset.slideNumberdesktop, 29 | slide_number_mobile = slide.dataset.slideNumbermobile, 30 | slide_centeredSlides = slide.dataset.slideCenteredslides, 31 | slide_spaceBetween = parseInt(slide.dataset.slideSpacebetween), 32 | slide_autoHeight = slide.dataset.slideAutoheight, 33 | spaceBetweenValue = 30, 34 | slidesCount = document.querySelectorAll( 35 | '#' + slide.id + ' .swiper-wrapper .swiper-slide' 36 | ).length, 37 | slide_loopMobile = slide.dataset.slideLoop ? slidesCount > slide_number_mobile : false, 38 | slide_loopDesktop = slide.dataset.slideLoop ? slidesCount > slide_number_desktop : false; 39 | var spaceBetweenValue = slide_spaceBetween ? slide_spaceBetween : spaceBetweenValue; 40 | var setting = { 41 | slidesPerView: slide_number_mobile, 42 | spaceBetween: spaceBetweenValue, 43 | autoHeight: slide_autoHeight, 44 | // Optional parameters 45 | loop: slide_loopMobile, 46 | watchOverflow: true, 47 | updateOnWindowResize: true, 48 | centeredSlides: slide_centeredSlides, 49 | effect: slide_effect, 50 | speed: slide_speed, 51 | direction: slide_direction, 52 | // If we need pagination 53 | pagination: { 54 | el: '.swiper-pagination', 55 | clickable: true, 56 | }, 57 | // Navigation arrows 58 | navigation: { 59 | nextEl: '.swiper-button-next', 60 | prevEl: '.swiper-button-prev', 61 | }, 62 | // Disable preloading of all images 63 | preloadImages: false, 64 | breakpoints: { 65 | 992: { 66 | slidesPerView: slide_number_desktop, 67 | loop: slide_loopDesktop, 68 | }, 69 | }, 70 | }; 71 | var mySwiper = new Swiper('#' + slide.id, setting); 72 | if (slide.id.includes('modal')) { 73 | var galleryModal = document.querySelectorAll("[id^='galleryModal']"); 74 | if (galleryModal) { 75 | galleryModal.forEach((modal) => { 76 | modal.addEventListener('shown.bs.modal', function (e) { 77 | mySwiper.update(); 78 | mySwiper.slideTo(e.relatedTarget.dataset.slideto, 0, false); 79 | document 80 | .querySelector(e.relatedTarget.dataset.bsTarget + ' .loading-first') 81 | .classList.add('d-none'); 82 | document 83 | .querySelector(e.relatedTarget.dataset.bsTarget + ' .swiper-button-prev') 84 | .classList.remove('d-none'); 85 | document 86 | .querySelector(e.relatedTarget.dataset.bsTarget + ' .swiper-button-next') 87 | .classList.remove('d-none'); 88 | }); 89 | modal.addEventListener('hidden.bs.modal', function (e) { 90 | document 91 | .querySelector('#' + e.currentTarget.id + ' .loading-first') 92 | .classList.remove('d-none'); 93 | document 94 | .querySelector('#' + e.currentTarget.id + ' .swiper-button-prev') 95 | .classList.add('d-none'); 96 | document 97 | .querySelector('#' + e.currentTarget.id + ' .swiper-button-next') 98 | .classList.add('d-none'); 99 | }); 100 | }); 101 | } 102 | } 103 | }, 104 | offset: '100%', 105 | }); 106 | }); 107 | -------------------------------------------------------------------------------- /src/entry/app.scss: -------------------------------------------------------------------------------- 1 | /** 2 | * @package AesirX 3 | * @subpackage SSO 4 | * 5 | * @copyright Copyright (C) 2022 AesirX. All rights reserved. 6 | * @license GNU General Public License version 2 or later; see LICENSE.txt 7 | */ 8 | 9 | // Layout & components 10 | @import '~bootstrap/scss/root'; 11 | @import '~bootstrap/scss/reboot'; 12 | @import '~bootstrap/scss/type'; 13 | @import '~bootstrap/scss/images'; 14 | @import '~bootstrap/scss/containers'; 15 | @import '~bootstrap/scss/grid'; 16 | // @import "~bootstrap/scss/tables"; 17 | @import '~bootstrap/scss/forms'; 18 | @import '~bootstrap/scss/buttons'; 19 | @import '~bootstrap/scss/transitions'; 20 | @import '~bootstrap/scss/dropdown'; 21 | @import '~bootstrap/scss/button-group'; 22 | @import '~bootstrap/scss/nav'; 23 | @import '~bootstrap/scss/navbar'; 24 | @import '~bootstrap/scss/alert'; 25 | @import '~bootstrap/scss/close'; 26 | 27 | // Helpers 28 | @import '~bootstrap/scss/helpers'; 29 | 30 | // Layouts 31 | @import '../scss/layouts/header'; 32 | @import '../scss/layouts/footer'; 33 | 34 | // Fonts 35 | @import '../fonts/fontface'; 36 | 37 | * { 38 | font-smoothing: antialiased; 39 | -webkit-font-smoothing: antialiased; 40 | -moz-osx-font-smoothing: grayscale; 41 | } 42 | body { 43 | background-color: $white; 44 | .body-wrap { 45 | height: 100vh; 46 | display: flex; 47 | align-items: center; 48 | justify-content: center; 49 | main { 50 | .body-login { 51 | h1 { 52 | text-align: center; 53 | font-size: 32px; 54 | margin-bottom: 24px; 55 | } 56 | .txt_or { 57 | position: relative; 58 | text-align: center; 59 | color: #8e8e8e; 60 | &::before { 61 | content: ''; 62 | position: absolute; 63 | width: 100%; 64 | top: 50%; 65 | left: 0; 66 | height: 1px; 67 | background: $border-color; 68 | z-index: -1; 69 | } 70 | } 71 | .logo-login { 72 | display: inline-block; 73 | margin: 5px 10px; 74 | .custom { 75 | display: flex; 76 | } 77 | } 78 | } 79 | .login { 80 | min-width: 480px; 81 | } 82 | .control-group { 83 | position: relative; 84 | margin-bottom: 24px; 85 | &:last-child { 86 | margin-bottom: 0; 87 | } 88 | .control-label { 89 | margin-bottom: 10px; 90 | font-weight: 600; 91 | color: $black; 92 | .star { 93 | color: $danger; 94 | } 95 | label[for='remember'] { 96 | margin-left: 30px; 97 | font-weight: 400; 98 | } 99 | } 100 | .controls { 101 | input { 102 | &:focus { 103 | box-shadow: 0 0 0 0.25rem rgba($success, 0.25); 104 | } 105 | &[type='text'], 106 | &[type='password'], 107 | &[type='email'] { 108 | width: 100%; 109 | background-color: $white; 110 | border: 1px solid #d5d5d5; 111 | line-height: 26px; 112 | padding: 10px 16px; 113 | border-radius: 0.25rem; 114 | outline: 0; 115 | } 116 | &[type='checkbox'] { 117 | &:checked { 118 | background-image: escape-svg($form-check-input-checked-bg-image); 119 | background-color: $success; 120 | } 121 | outline: 0; 122 | background-color: $white; 123 | appearance: none; 124 | border-radius: 0.25em; 125 | background-position: 50%; 126 | background-repeat: no-repeat; 127 | background-size: contain; 128 | border: 1px solid $border-color; 129 | height: 1.5em; 130 | vertical-align: top; 131 | width: 1.5em; 132 | } 133 | } 134 | #remember { 135 | position: absolute; 136 | left: 0; 137 | top: 50%; 138 | transform: translateY(-50%); 139 | } 140 | } 141 | .btn { 142 | width: 100%; 143 | padding: 13px; 144 | display: flex; 145 | align-items: center; 146 | justify-content: center; 147 | &[title='Cancel'] { 148 | @include button-variant( 149 | $white /*background*/, 150 | #d5d5d5 /*border*/, 151 | $danger /*text color*/, 152 | darken($white, 5%) /*hover background*/, 153 | #d5d5d5 /*hover border*/, 154 | $danger /*hover text color*/ 155 | ); 156 | } 157 | } 158 | } 159 | .nav-tabs { 160 | display: flex; 161 | flex-wrap: wrap; 162 | border-bottom: 0; 163 | li { 164 | width: 100%; 165 | margin-bottom: 15px; 166 | a { 167 | text-decoration: none; 168 | } 169 | } 170 | } 171 | } 172 | } 173 | } 174 | @include media-breakpoint-down(sm) { 175 | body { 176 | .body-wrap { 177 | main { 178 | width: 100%; 179 | .body-login { 180 | h1 { 181 | font-size: 28px; 182 | } 183 | } 184 | .login { 185 | min-width: auto; 186 | } 187 | } 188 | } 189 | .walletconnect-modal__footer { 190 | flex-wrap: wrap; 191 | } 192 | } 193 | } 194 | -------------------------------------------------------------------------------- /webpack.template.js: -------------------------------------------------------------------------------- 1 | const path = require('path'); 2 | const HtmlWebpackPlugin = require('html-webpack-plugin'); 3 | const BrowserSyncPlugin = require('browser-sync-webpack-plugin'); 4 | const MediaQueryPlugin = require('aesirxio-template-library/media-query-plugin'); 5 | const WebpackAssetsManifest = require('webpack-assets-manifest'); 6 | const FileManagerPlugin = require('filemanager-webpack-plugin'); 7 | const MiniCssExtractPlugin = require('mini-css-extract-plugin'); 8 | const RealFaviconPlugin = require('aesirxio-template-library/real-favicon-webpack-plugin'); 9 | const TerserPlugin = require('terser-webpack-plugin'); 10 | const RemoveEmptyScriptsPlugin = require('webpack-remove-empty-scripts'); 11 | const FontPreloadPlugin = require('webpack-font-preload-plugin'); 12 | const { DefinePlugin } = require('webpack'); 13 | 14 | const { 15 | queryData, 16 | entryData, 17 | wwwDir, 18 | projectname, 19 | sassLoader, 20 | imageLoader, 21 | fontLoader, 22 | jsLoader, 23 | cssLoader, 24 | aliasData, 25 | } = require('./webpack.common'); 26 | 27 | require('dotenv').config(); 28 | 29 | module.exports = (env, argv) => { 30 | if (env != undefined && env.deploy) { 31 | process.env = { 32 | ...process.env, 33 | wwwDir, 34 | projectname, 35 | }; 36 | 37 | var templatePath = process.env.wwwDir; 38 | } else { 39 | var templatePath = process.env.wwwDir + '/' + process.env.projectname; 40 | } 41 | 42 | var config = { 43 | entry: entryData, 44 | plugins: [ 45 | new DefinePlugin({ 46 | process: { 47 | env: JSON.stringify({ 48 | REACT_APP_SSO_CONCORDIUM_NETWORK: process.env.REACT_APP_SSO_CONCORDIUM_NETWORK, 49 | REACT_APP_ENDPOINT_URL: process.env.REACT_APP_ENDPOINT_URL, 50 | REACT_APP_SSO_CLIENT_ID: process.env.REACT_APP_SSO_CLIENT_ID, 51 | REACT_APP_SSO_CLIENT_SECRET: process.env.REACT_APP_SSO_CLIENT_SECRET, 52 | }), 53 | }, 54 | }), 55 | new HtmlWebpackPlugin({ 56 | inject: false, 57 | filename: templatePath + '/templates/' + process.env.projectname + '/index.php', 58 | template: './template/index.php', 59 | excludeAssets: [/.*./], 60 | realfavicons: true, 61 | minify: false, 62 | }), 63 | new HtmlWebpackPlugin({ 64 | inject: false, 65 | filename: templatePath + '/templates/' + process.env.projectname + '/component.php', 66 | template: './template/component.php', 67 | chunks: ['views.component'], 68 | excludeAssets: [/.*./], 69 | minify: false, 70 | }), 71 | new HtmlWebpackPlugin({ 72 | inject: false, 73 | filename: templatePath + '/templates/' + process.env.projectname + '/templateDetails.xml', 74 | template: './template/templateDetails.xml', 75 | templateParameters: process.env, 76 | minify: false, 77 | }), 78 | new HtmlWebpackPlugin({ 79 | filename: 80 | templatePath + 81 | '/templates/' + 82 | process.env.projectname + 83 | '/html/layouts/oauth2/authorize.php', 84 | template: './template/html/layouts/oauth2/authorize.php', 85 | templateParameters: process.env, 86 | minify: false, 87 | }), 88 | new FileManagerPlugin({ 89 | events: { 90 | onEnd: { 91 | copy: [ 92 | { 93 | source: path.resolve(__dirname, './template/html/com_users'), 94 | destination: 95 | templatePath + '/templates/' + process.env.projectname + '/html/com_users', 96 | options: { 97 | force: true, 98 | }, 99 | }, 100 | 101 | { 102 | source: path.resolve(__dirname, './template/helper.php'), 103 | destination: templatePath + '/templates/' + process.env.projectname + '/helper.php', 104 | }, 105 | { 106 | source: path.resolve(__dirname, './vendor'), 107 | destination: templatePath + '/templates/' + process.env.projectname + '/vendor', 108 | }, 109 | { 110 | source: path.resolve(__dirname, './template/template_preview.png'), 111 | destination: 112 | templatePath + '/templates/' + process.env.projectname + '/template_preview.png', 113 | }, 114 | { 115 | source: path.resolve(__dirname, './template/template_thumbnail.png'), 116 | destination: 117 | templatePath + 118 | '/templates/' + 119 | process.env.projectname + 120 | '/template_thumbnail.png', 121 | }, 122 | ], 123 | }, 124 | onStart: { 125 | delete: [ 126 | { 127 | source: templatePath + '/templates/' + process.env.projectname + '/html', 128 | options: { 129 | force: true, 130 | }, 131 | }, 132 | ], 133 | }, 134 | }, 135 | }), 136 | new MediaQueryPlugin({ 137 | include: true, 138 | queries: queryData, 139 | outputFileName: ({ path, queryname }) => { 140 | const pathParts = path 141 | .replace(__dirname + '/src/entry/', '') 142 | .replace(/\//g, '.') 143 | .replace('.scss', ''); 144 | 145 | return `${pathParts}-${queryname}`; 146 | }, 147 | }), 148 | new WebpackAssetsManifest({ 149 | entrypoints: true, 150 | publicPath: '/templates/' + process.env.projectname + '/', 151 | }), 152 | new RemoveEmptyScriptsPlugin(), 153 | 154 | new FontPreloadPlugin({ 155 | index: 'index.php', 156 | extensions: ['woff2'], 157 | replaceCallback: ({ indexSource, linksAsString }) => { 158 | return indexSource.replace('{{{fontPreload}}}', linksAsString); 159 | }, 160 | }), 161 | ], 162 | output: { 163 | path: templatePath + '/templates/' + process.env.projectname + '/', 164 | publicPath: '/templates/' + process.env.projectname + '/', 165 | }, 166 | module: { 167 | rules: [sassLoader, cssLoader, jsLoader, imageLoader, fontLoader], 168 | }, 169 | optimization: { 170 | splitChunks: { 171 | maxInitialRequests: Infinity, 172 | minSize: 0, 173 | cacheGroups: { 174 | vendor: { 175 | test: /[\\/]node_modules[\\/]/, 176 | name(module) { 177 | // get the name. E.g. node_modules/packageName/not/this/part.js 178 | // or node_modules/packageName 179 | const packageName = module.context.match(/[\\/]node_modules[\\/](.*?)([\\/]|$)/)[1]; 180 | 181 | // npm package names are URL-safe, but some servers don't like @ symbols 182 | return `npm.${packageName.replace('@', '')}`; 183 | }, 184 | }, 185 | }, 186 | }, 187 | }, 188 | resolve: { 189 | alias: aliasData, 190 | }, 191 | }; 192 | 193 | let name = '[name]'; 194 | 195 | if (argv.mode === 'development') { 196 | config.devtool = 'source-map'; 197 | 198 | if (env != undefined && env.deploy) { 199 | name = '[name].[contenthash]'; 200 | } 201 | 202 | config.plugins.push( 203 | new BrowserSyncPlugin( 204 | // BrowserSync options 205 | { 206 | proxy: process.env.projectname + '.local', 207 | notify: true, 208 | } 209 | ), 210 | new MiniCssExtractPlugin({ 211 | filename: 'css/' + name + '.css', 212 | }) 213 | ); 214 | } 215 | 216 | if (argv.mode === 'production') { 217 | name = '[name].[contenthash]'; 218 | 219 | config.optimization.minimize = true; 220 | config.optimization.minimizer = [ 221 | new TerserPlugin({ 222 | terserOptions: { 223 | compress: { 224 | drop_console: true, 225 | }, 226 | }, 227 | }), 228 | ]; 229 | 230 | config.plugins.push( 231 | new MiniCssExtractPlugin({ 232 | filename: 'css/' + name + '.css', 233 | }), 234 | new RealFaviconPlugin({ 235 | favicon: path.resolve(__dirname, './src/favicon/favicon.png'), 236 | faviconJson: path.resolve(__dirname, './src/favicon/favicon.json'), 237 | publicPath: '/templates/' + process.env.projectname + '/favicon', 238 | outputPath: templatePath + '/templates/' + process.env.projectname + '/favicon', 239 | }) 240 | ); 241 | } 242 | 243 | config.output.filename = 'js/' + name + '.js'; 244 | config.output.chunkFilename = 'js/' + name + '.js'; 245 | 246 | return config; 247 | }; 248 | -------------------------------------------------------------------------------- /template/helper.php: -------------------------------------------------------------------------------- 1 | getTemplate(); 60 | } 61 | 62 | /** 63 | * Method to get current Page Option 64 | * 65 | * @access public 66 | * 67 | * @return mixed 68 | * @since 1.0 69 | */ 70 | public static function getPageOption() 71 | { 72 | return Factory::getApplication()->input->getCmd('option', ''); 73 | } 74 | 75 | /** 76 | * Method to get current Page View 77 | * 78 | * @access public 79 | * 80 | * @return mixed 81 | * @since 1.0 82 | */ 83 | public static function getPageView() 84 | { 85 | return Factory::getApplication()->input->getCmd('view', ''); 86 | } 87 | 88 | /** 89 | * Method to get current Page Layout 90 | * 91 | * @access public 92 | * 93 | * @return mixed 94 | * @since version 95 | */ 96 | public static function getPageLayout() 97 | { 98 | $layout = self::getAesirLayout(); 99 | 100 | if ($layout) { 101 | return $layout; 102 | } 103 | 104 | return Factory::getApplication()->input->getCmd('layout', 'default'); 105 | } 106 | 107 | /** 108 | * Method to get current Page Task 109 | * 110 | * @access public 111 | * 112 | * @return mixed 113 | * @since 1.0 114 | */ 115 | public static function getPageTask() 116 | { 117 | return Factory::getApplication()->input->getCmd('task', ''); 118 | } 119 | 120 | /** 121 | * Method to get the current Menu Item ID 122 | * 123 | * @access public 124 | * 125 | * @return integer 126 | * @since 1.0 127 | */ 128 | public static function getItemId() 129 | { 130 | return Factory::getApplication()->input->getInt('Itemid'); 131 | } 132 | 133 | /** 134 | * Method to get PageClass set with Menu Item 135 | * 136 | * @return mixed 137 | * @since 1.0 138 | */ 139 | public static function getPageClass() 140 | { 141 | $activeMenu = Factory::getApplication()->getMenu()->getActive(); 142 | $pageclass = ($activeMenu) ? $activeMenu->params->get('pageclass_sfx', '') : ''; 143 | 144 | return $pageclass; 145 | } 146 | 147 | /** 148 | * Method to determine whether the current page is the Joomla! homepage 149 | * 150 | * @access public 151 | * 152 | * @return boolean 153 | * @since 1.0 154 | */ 155 | public static function isHome() 156 | { 157 | // Fetch the active menu-item 158 | $activeMenu = Factory::getApplication()->getMenu()->getActive(); 159 | 160 | // Return whether this active menu-item is home or not 161 | return (bool) ($activeMenu) ? $activeMenu->home : false; 162 | } 163 | 164 | /** 165 | * Method to fetch the current path 166 | * 167 | * @access public 168 | * 169 | * @param string $output Output type 170 | * 171 | * @return mixed 172 | * @since 1.0 173 | */ 174 | public static function getPath($output = 'array') 175 | { 176 | $path = Uri::getInstance()->getPath(); 177 | $path = preg_replace('/^\//', '', $path); 178 | 179 | if ($output == 'array') { 180 | $path = explode('/', $path); 181 | 182 | return $path; 183 | } 184 | 185 | return $path; 186 | } 187 | 188 | /** 189 | * Generate a list of useful CSS classes for the body 190 | * 191 | * @access public 192 | * 193 | * @return boolean 194 | * @since 1.0 195 | */ 196 | public static function setBodySuffix() 197 | { 198 | $classes = array(); 199 | $classes[] = 'option-' . self::getPageOption(); 200 | $classes[] = 'view-' . self::getPageView(); 201 | $classes[] = 'layout-' . self::getPageLayout(); 202 | $classes[] = self::getPageTask() ? 'task-' . self::getPageTask() : 'no-task'; 203 | $classes[] = 'itemid-' . self::getItemId(); 204 | $classes[] = self::getPageClass(); 205 | $classes[] = self::isHome() ? 'path-home' : 'path-' . implode('-', self::getPath('array')); 206 | 207 | return implode(' ', $classes); 208 | } 209 | 210 | /** 211 | * Method to manually override the META-generator 212 | * 213 | * @access public 214 | * 215 | * @param string $generator Generator 216 | * 217 | * @return void 218 | * 219 | * @since 1.0 220 | */ 221 | public static function setGenerator($generator) 222 | { 223 | Factory::getDocument()->setGenerator($generator); 224 | } 225 | 226 | /** 227 | * Method to get the current sitename 228 | * 229 | * @access public 230 | * 231 | * @return string 232 | * @since 1.0 233 | */ 234 | public static function getSitename() 235 | { 236 | return Factory::getConfig()->get('sitename'); 237 | } 238 | 239 | /** 240 | * Method to set some Meta data 241 | * 242 | * @access public 243 | * 244 | * @return void 245 | * @since 1.0 246 | */ 247 | public static function setMetadata() 248 | { 249 | $doc = Factory::getDocument(); 250 | 251 | $doc->setHtml5(true); 252 | $doc->setMetaData('X-UA-Compatible', 'IE=edge', true); 253 | $doc->setMetaData('viewport', 'width=device-width, initial-scale=1, shrink-to-fit=no'); 254 | $doc->addHeadLink(Uri::current(), 'canonical', 'rel'); 255 | } 256 | 257 | /** 258 | * Method to set manifest 259 | * 260 | * @access public 261 | * 262 | * @return void 263 | * @since 1.0 264 | */ 265 | public static function loadManifest() 266 | { 267 | $doc = Factory::getDocument(); 268 | $manifest = file_get_contents(JPATH_THEMES . '/' . Factory::getDocument()->template . '/assets-manifest.json'); 269 | $json = json_decode($manifest, true); 270 | 271 | $criticalPath = JPATH_THEMES . '/' . Factory::getDocument()->template . '/css/critical.css'; 272 | 273 | if (file_exists($criticalPath)) { 274 | $doc->addStyleDeclaration(file_get_contents($criticalPath)); 275 | } 276 | 277 | // Index 278 | self::addScript($json, 'app'); 279 | 280 | // Home or page 281 | if (self::isHome()) { 282 | $name = 'views.homepage'; 283 | } else { 284 | $name = self::getPageOption() . '.' . self::getPageView() . '.' . self::getPageLayout(); 285 | } 286 | 287 | self::addScript($json, $name); 288 | 289 | // Modules 290 | $modules = ModuleHelper::getModuleList(); 291 | 292 | if (count($modules) > 0) { 293 | foreach ($modules as $module) { 294 | $params = new CMSRegistry($module->params); 295 | 296 | if (empty($module->position)) { 297 | continue; 298 | } 299 | 300 | $name = 'modules.' . $module->module . '.' . $module->position; 301 | 302 | self::addScript($json, $name); 303 | 304 | if (!empty($params->get('moduleclass_sfx', ''))) { 305 | $sfx = preg_replace('/\s+/', '', $params->get('moduleclass_sfx', '')); 306 | $name .= '.' . $sfx; 307 | 308 | self::addScript($json, $name); 309 | } 310 | } 311 | } 312 | 313 | if (self::$scripts) { 314 | foreach (self::$scripts as $script) { 315 | $doc->addScript($script, "text/javascript", true); 316 | } 317 | } 318 | 319 | if (self::$styles) { 320 | foreach (self::$styles as $i => $style) { 321 | $doc->addCustomTag(''); 322 | } 323 | } 324 | } 325 | 326 | /** 327 | * Method to set script 328 | * 329 | * @access public 330 | * 331 | * @return void 332 | * @since 1.0 333 | */ 334 | private static function addScript($json, $name) 335 | { 336 | $entrypoints = $json['entrypoints']; 337 | 338 | if (isset($entrypoints[$name]['assets']['css'])) { 339 | $css = $entrypoints[$name]['assets']['css']; 340 | 341 | foreach ($css as $item) { 342 | self::$styles[md5($item)] = $item; 343 | } 344 | } 345 | 346 | if (isset($entrypoints[$name]['assets']['js'])) { 347 | $js = $entrypoints[$name]['assets']['js']; 348 | 349 | foreach ($js as $item) { 350 | self::$scripts[md5($item)] = $item; 351 | } 352 | } 353 | 354 | $detect = new \Detection\MobileDetect; 355 | 356 | if (isset($json[$name . '-tablet.css']) && $detect->isTablet()) { 357 | self::$styles[md5($name . '-tablet.css')] = $json[$name . '-tablet.css']; 358 | } 359 | 360 | if (isset($json[$name . '-desktop.css']) && !$detect->isMobile() && !$detect->isTablet()) { 361 | if (isset($json[$name . '-tablet.css'])) { 362 | self::$styles[md5($name . '-tablet.css')] = $json[$name . '-tablet.css']; 363 | } 364 | 365 | self::$styles[md5($name . '-desktop.css')] = $json[$name . '-desktop.css']; 366 | } 367 | } 368 | 369 | /** 370 | * Load the active category. 371 | * 372 | * @return self 373 | * 374 | * @throws Exception 375 | */ 376 | private static function getActiveAesirCategory() 377 | { 378 | $app = Factory::getApplication(); 379 | 380 | $categoryId = $app->input->getInt('id', 0); 381 | 382 | if (!$categoryId) { 383 | return false; 384 | } 385 | 386 | $category = ReditemEntityCategory::load($categoryId); 387 | 388 | if ($category->canView()) { 389 | return $category; 390 | } 391 | 392 | return false; 393 | } 394 | 395 | /** 396 | * Get the layout. 397 | * 398 | * @return string The layout name 399 | * 400 | * @throws Exception 401 | */ 402 | private static function getAesirLayout() 403 | { 404 | $option = self::getPageOption(); 405 | 406 | if ($option != 'com_reditem') { 407 | return false; 408 | } 409 | 410 | $app = Factory::getApplication(); 411 | $id = $app->input->getInt('id', 0); 412 | 413 | if (!$id) { 414 | return false; 415 | } 416 | 417 | $view = self::getPageView(); 418 | $entity = null; 419 | 420 | if (in_array($view, array('category_items', 'category_descendant_items'))) { 421 | $entity = ReditemEntityCategory::load($id); 422 | 423 | return $entity->layout ?? 'default'; 424 | } elseif (in_array($view, array('itemdetail', 'item'))) { 425 | $entity = ReditemEntityItem::load($id); 426 | 427 | return $entity->layout ?? 'default'; 428 | } elseif (in_array($view, array('type_items'))) { 429 | $menus = $app->getMenu(); 430 | $activeMenu = $menus->getActive()->params; 431 | 432 | return $activeMenu->get('layout', 'default'); 433 | } 434 | 435 | return false; 436 | } 437 | } 438 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------