This commit is contained in:
240
.github/workflows/release_build.yml
vendored
Normal file
240
.github/workflows/release_build.yml
vendored
Normal file
@@ -0,0 +1,240 @@
|
|||||||
|
name: Build, Push, Publish
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
workflow_dispatch:
|
||||||
|
schedule:
|
||||||
|
- cron: '28 5 * * *'
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["Sync Repo"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
name: Build & Release
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
packages: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: 📥 Checkout code with full history and tags
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Check if any tags exist
|
||||||
|
id: check_tags_exist
|
||||||
|
run: |
|
||||||
|
git fetch --tags
|
||||||
|
TAG_COUNT=$(git tag | wc -l)
|
||||||
|
if [ "$TAG_COUNT" -eq 0 ]; then
|
||||||
|
echo "has_tags=false" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "latest_tag=v0.0.0" >> "$GITHUB_OUTPUT"
|
||||||
|
else
|
||||||
|
echo "has_tags=true" >> "$GITHUB_OUTPUT"
|
||||||
|
LATEST_TAG=$(git describe --tags --abbrev=0)
|
||||||
|
echo "latest_tag=$LATEST_TAG" >> "$GITHUB_OUTPUT"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Check if meaningful commits exist since latest tag
|
||||||
|
id: check_commits
|
||||||
|
run: |
|
||||||
|
if [ "${{ steps.check_tags_exist.outputs.has_tags }}" = "false" ]; then
|
||||||
|
# No tags exist, so we should create first release
|
||||||
|
echo "commit_count=1" >> "$GITHUB_OUTPUT"
|
||||||
|
CHANGED_FILES=$(git ls-files | grep -v '^manifest.json$' || true)
|
||||||
|
if [ -n "$CHANGED_FILES" ]; then
|
||||||
|
echo "changed_files<<EOF" >> "$GITHUB_OUTPUT"
|
||||||
|
printf '%s\n' "$CHANGED_FILES" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "EOF" >> "$GITHUB_OUTPUT"
|
||||||
|
else
|
||||||
|
echo "changed_files=Initial release" >> "$GITHUB_OUTPUT"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
LATEST_TAG="${{ steps.check_tags_exist.outputs.latest_tag }}"
|
||||||
|
CHANGED_FILES="$(git diff --name-only "${LATEST_TAG}..HEAD" | grep -v '^manifest.json$' || true)"
|
||||||
|
if [ -n "$CHANGED_FILES" ]; then
|
||||||
|
echo "commit_count=1" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "changed_files<<EOF" >> "$GITHUB_OUTPUT"
|
||||||
|
printf '%s\n' "$CHANGED_FILES" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "EOF" >> "$GITHUB_OUTPUT"
|
||||||
|
else
|
||||||
|
echo "commit_count=0" >> "$GITHUB_OUTPUT"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Get latest release tag (from GitHub API)
|
||||||
|
id: get_latest_release
|
||||||
|
run: |
|
||||||
|
LATEST_RELEASE_TAG=$(curl -sL -H "Accept: application/vnd.github+json" \
|
||||||
|
-H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
|
||||||
|
"https://api.github.com/repos/${GITHUB_REPOSITORY}/releases/latest" | jq -r .tag_name)
|
||||||
|
if [ -z "$LATEST_RELEASE_TAG" ] || [ "$LATEST_RELEASE_TAG" = "null" ]; then
|
||||||
|
LATEST_RELEASE_TAG="v1.0.0"
|
||||||
|
fi
|
||||||
|
echo "latest_release_tag=$LATEST_RELEASE_TAG" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "latest_release_version=${LATEST_RELEASE_TAG#v}" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
# -------------------------------
|
||||||
|
# Sync manifest.json to last release version if behind (only when no meaningful commits)
|
||||||
|
# -------------------------------
|
||||||
|
- name: 🛠 Ensure manifest.json matches latest release version
|
||||||
|
if: steps.check_commits.outputs.commit_count == '0'
|
||||||
|
run: |
|
||||||
|
if [ -f manifest.json ]; then
|
||||||
|
MANIFEST_VERSION=$(jq -r '.version // empty' manifest.json)
|
||||||
|
else
|
||||||
|
MANIFEST_VERSION=""
|
||||||
|
fi
|
||||||
|
LATEST_RELEASE_VERSION="${{ steps.get_latest_release.outputs.latest_release_version }}"
|
||||||
|
PYTHON_CODE="from packaging import version; \
|
||||||
|
print(version.parse('$LATEST_RELEASE_VERSION') > version.parse('$MANIFEST_VERSION') if '$MANIFEST_VERSION' else True)"
|
||||||
|
NEED_UPDATE=$(python3 -c "$PYTHON_CODE")
|
||||||
|
if [ "$NEED_UPDATE" = "True" ]; then
|
||||||
|
echo "Updating manifest.json to version $LATEST_RELEASE_VERSION (sync with release)"
|
||||||
|
jq --arg v "$LATEST_RELEASE_VERSION" '.version = $v' manifest.json > tmp.json && mv tmp.json manifest.json
|
||||||
|
git config user.name "github-actions"
|
||||||
|
git config user.email "github-actions@github.com"
|
||||||
|
git add manifest.json
|
||||||
|
git commit -m "Sync manifest.json to release $LATEST_RELEASE_VERSION [🔄]" || echo "Nothing to commit"
|
||||||
|
git push origin main || true
|
||||||
|
else
|
||||||
|
echo "Manifest.json is already up-to-date with the latest release."
|
||||||
|
fi
|
||||||
|
|
||||||
|
# -------------------------------
|
||||||
|
# Continue normal workflow if commits exist
|
||||||
|
# -------------------------------
|
||||||
|
- name: 📃 Get list of changed files (Markdown bullet list)
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0'
|
||||||
|
id: changed_files
|
||||||
|
run: |
|
||||||
|
BULLET_LIST="$(printf '%s\n' "${{ steps.check_commits.outputs.changed_files }}" | sed 's/^/- /')"
|
||||||
|
echo "CHANGED<<EOF" >> "$GITHUB_OUTPUT"
|
||||||
|
printf '%s\n' "$BULLET_LIST" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "EOF" >> "$GITHUB_OUTPUT"
|
||||||
|
COUNT="$(printf '%s\n' "${{ steps.check_commits.outputs.changed_files }}" | wc -l)"
|
||||||
|
echo "COUNT=$COUNT" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Get manifest version
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0'
|
||||||
|
id: get_manifest_version
|
||||||
|
run: |
|
||||||
|
if [ -f manifest.json ]; then
|
||||||
|
MANIFEST_VERSION=$(jq -r '.version // empty' manifest.json)
|
||||||
|
if [ -z "$MANIFEST_VERSION" ] || [ "$MANIFEST_VERSION" = "null" ]; then
|
||||||
|
MANIFEST_VERSION="1.0.0"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
MANIFEST_VERSION="1.0.0"
|
||||||
|
fi
|
||||||
|
echo "manifest_version=$MANIFEST_VERSION" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Pick base version
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0'
|
||||||
|
id: pick_base_version
|
||||||
|
run: |
|
||||||
|
LATEST_RELEASE="${{ steps.get_latest_release.outputs.latest_release_version }}"
|
||||||
|
MANIFEST="${{ steps.get_manifest_version.outputs.manifest_version }}"
|
||||||
|
BASE_VERSION=$(python3 -c "from packaging import version; \
|
||||||
|
print(str(max(version.parse('$LATEST_RELEASE'), version.parse('$MANIFEST'))))")
|
||||||
|
echo "base_version=$BASE_VERSION" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: 🔢 Determine version
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0'
|
||||||
|
id: version
|
||||||
|
run: |
|
||||||
|
BASE_VERSION="${{ steps.pick_base_version.outputs.base_version }}"
|
||||||
|
IFS='.' read -r MAJOR MINOR PATCH <<< "$BASE_VERSION"
|
||||||
|
COUNT="${{ steps.changed_files.outputs.COUNT }}"
|
||||||
|
if [ "$COUNT" -ge 5 ]; then
|
||||||
|
MAJOR=$((MAJOR + 1))
|
||||||
|
MINOR=0
|
||||||
|
PATCH=0
|
||||||
|
elif [ "$COUNT" -ge 3 ]; then
|
||||||
|
MINOR=$((MINOR + 1))
|
||||||
|
PATCH=0
|
||||||
|
else
|
||||||
|
PATCH=$((PATCH + 1))
|
||||||
|
fi
|
||||||
|
NEW_VERSION="${MAJOR}.${MINOR}.${PATCH}"
|
||||||
|
REPO_NAME="$(basename "$GITHUB_REPOSITORY")"
|
||||||
|
ZIP_NAME="${REPO_NAME}-${NEW_VERSION}.zip"
|
||||||
|
echo "VERSION=$NEW_VERSION" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "ZIP_NAME=$ZIP_NAME" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "REPO_NAME=$REPO_NAME" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: 🛠 Update or create manifest.json
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0'
|
||||||
|
run: |
|
||||||
|
VERSION="${{ steps.version.outputs.VERSION }}"
|
||||||
|
AUTHOR="Ivan Carlos"
|
||||||
|
VERSION_FILE="manifest.json"
|
||||||
|
if [ -f "$VERSION_FILE" ]; then
|
||||||
|
jq --arg v "$VERSION" --arg a "$AUTHOR" \
|
||||||
|
'.version = $v | .author = $a' "$VERSION_FILE" > tmp.json && mv tmp.json "$VERSION_FILE"
|
||||||
|
else
|
||||||
|
echo "{ \"version\": \"$VERSION\", \"author\": \"$AUTHOR\" }" > "$VERSION_FILE"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: 💾 Commit and push updated manifest.json
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0'
|
||||||
|
run: |
|
||||||
|
git config user.name "github-actions"
|
||||||
|
git config user.email "github-actions@github.com"
|
||||||
|
git add manifest.json
|
||||||
|
git commit -m "Update manifest version to ${{ steps.version.outputs.VERSION }} [▶️]" || echo "Nothing to commit"
|
||||||
|
git push origin main
|
||||||
|
|
||||||
|
- name: 📦 Create ZIP package (excluding certain files)
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0'
|
||||||
|
run: |
|
||||||
|
ZIP_NAME="${{ steps.version.outputs.ZIP_NAME }}"
|
||||||
|
zip -r "$ZIP_NAME" . -x ".git/*" ".github/*" "docker/*" ".dockerignore" "CNAME" "Dockerfile" "README.md" "LICENSE"
|
||||||
|
|
||||||
|
- name: 🚀 Create GitHub Release
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0'
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
tag_name: "v${{ steps.version.outputs.VERSION }}"
|
||||||
|
name: "${{ steps.version.outputs.REPO_NAME }} v${{ steps.version.outputs.VERSION }}"
|
||||||
|
body: |
|
||||||
|
### Changelog
|
||||||
|
Files changed in this release:
|
||||||
|
${{ steps.changed_files.outputs.CHANGED }}
|
||||||
|
files: ${{ steps.version.outputs.ZIP_NAME }}
|
||||||
|
|
||||||
|
# ----- Docker steps -----
|
||||||
|
- name: 🔍 Check if Dockerfile exists
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0'
|
||||||
|
id: dockerfile_check
|
||||||
|
run: |
|
||||||
|
if [ -f Dockerfile ]; then
|
||||||
|
echo "exists=true" >> "$GITHUB_OUTPUT"
|
||||||
|
else
|
||||||
|
echo "exists=false" >> "$GITHUB_OUTPUT"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: 🛠 Set up Docker Buildx
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0' && steps.dockerfile_check.outputs.exists == 'true'
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: 🔐 Login to GitHub Container Registry
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0' && steps.dockerfile_check.outputs.exists == 'true'
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
registry: ghcr.io
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: 🐳 Build and Push Docker image
|
||||||
|
if: steps.check_commits.outputs.commit_count != '0' && steps.dockerfile_check.outputs.exists == 'true'
|
||||||
|
uses: docker/build-push-action@v5
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
push: true
|
||||||
|
tags: ghcr.io/${{ github.repository }}:latest
|
||||||
78
.github/workflows/update_readme.yml
vendored
Normal file
78
.github/workflows/update_readme.yml
vendored
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
name: Update README
|
||||||
|
|
||||||
|
# Allow GitHub Actions to commit and push changes
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
schedule:
|
||||||
|
- cron: '0 4 * * *' # Every day at 4 AM UTC
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
update-readme:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
env:
|
||||||
|
SOURCE_REPO: ivancarlosti/.github
|
||||||
|
SOURCE_BRANCH: main
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout current repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Checkout source README template
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
repository: ${{ env.SOURCE_REPO }}
|
||||||
|
ref: ${{ env.SOURCE_BRANCH }}
|
||||||
|
path: source_readme
|
||||||
|
|
||||||
|
- name: Update README.md (buttons and footer)
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
REPO_NAME="${GITHUB_REPOSITORY##*/}"
|
||||||
|
|
||||||
|
# --- Extract buttons block from source ---
|
||||||
|
BUTTONS=$(awk '/<!-- buttons -->/{flag=1;next}/<!-- endbuttons -->/{flag=0}flag' source_readme/README.md)
|
||||||
|
BUTTONS_UPDATED=$(echo "$BUTTONS" | sed "s/\.github/${REPO_NAME}/g")
|
||||||
|
|
||||||
|
# --- Extract footer block from source (everything from <!-- footer --> onward) ---
|
||||||
|
FOOTER=$(awk '/<!-- footer -->/{flag=1}flag' source_readme/README.md)
|
||||||
|
|
||||||
|
# --- Replace buttons section in README.md ---
|
||||||
|
UPDATED=$(awk -v buttons="$BUTTONS_UPDATED" '
|
||||||
|
BEGIN { skip=0 }
|
||||||
|
/<!-- buttons -->/ {
|
||||||
|
print
|
||||||
|
print buttons
|
||||||
|
skip=1
|
||||||
|
next
|
||||||
|
}
|
||||||
|
/<!-- endbuttons -->/ && skip {
|
||||||
|
print
|
||||||
|
skip=0
|
||||||
|
next
|
||||||
|
}
|
||||||
|
!skip { print }
|
||||||
|
' README.md)
|
||||||
|
|
||||||
|
# --- Replace everything after <!-- footer --> with FOOTER ---
|
||||||
|
echo "$UPDATED" | awk -v footer="$FOOTER" '
|
||||||
|
/<!-- footer -->/ {
|
||||||
|
print footer
|
||||||
|
found=1
|
||||||
|
exit
|
||||||
|
}
|
||||||
|
{ print }
|
||||||
|
' > README.tmp && mv README.tmp README.md
|
||||||
|
|
||||||
|
- name: Remove source_readme from git index
|
||||||
|
run: git rm --cached -r source_readme || true
|
||||||
|
|
||||||
|
- name: Commit and push changes
|
||||||
|
uses: stefanzweifel/git-auto-commit-action@v5
|
||||||
|
with:
|
||||||
|
file_pattern: README.md
|
||||||
|
commit_message: "Sync README from template [▶️]"
|
||||||
|
branch: ${{ github.ref_name }}
|
||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2025 Ivan Carlos de Almeida
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
76
README.md
76
README.md
@@ -1,2 +1,76 @@
|
|||||||
# yourlsiccwebmastersettings
|
# ICC Meta Redirect plugin for YOURLS
|
||||||
|
This YOURLS plugin make it possible to change logo, title, page footer, add custom CSS, and customize favicon lines into your YOURLS installation.
|
||||||
|
|
||||||
|
<!-- buttons -->
|
||||||
|
[](https://github.com/ivancarlosti/yourlsiccwebmastersettings/stargazers)
|
||||||
|
[](https://github.com/sponsors/ivancarlosti)
|
||||||
|
[](https://github.com/sponsors/ivancarlosti)
|
||||||
|
[](https://github.com/ivancarlosti/yourlsiccwebmastersettings/pulse)
|
||||||
|
[](https://github.com/ivancarlosti/yourlsiccwebmastersettings/issues)
|
||||||
|
[](LICENSE)
|
||||||
|
[](https://github.com/ivancarlosti/yourlsiccwebmastersettings/commits)
|
||||||
|
[](https://github.com/ivancarlosti/yourlsiccwebmastersettings/security)
|
||||||
|
[](https://github.com/ivancarlosti/yourlsiccwebmastersettings?tab=coc-ov-file)
|
||||||
|
[][sponsor]
|
||||||
|
<!-- endbuttons -->
|
||||||
|
|
||||||
|
## Inspiration
|
||||||
|
* Project inspired by [YOURLS-GWallChangeLogo](https://github.com/gioxx/YOURLS-GWallChangeLogo), [YOURLS-GWallChangeTitle](https://github.com/gioxx/YOURLS-GWallChangeTitle),.
|
||||||
|
|
||||||
|
## Instructions
|
||||||
|
* Download the plugin release
|
||||||
|
* Create the folder `icc-webmaster-settings` into YOURLS path `/user/plugins` and store `plugin.php` on it
|
||||||
|
* Activate plugin in `/admin/plugins.php` page of your YOURLS installation
|
||||||
|
* Access `Webmaster Settings` page
|
||||||
|
* Manage settings and save
|
||||||
|
* Go back to another page to see logo, title, footer, custom css and favicon changes
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
* YOURLS 1.10+
|
||||||
|
|
||||||
|
## CSS snippet suggestion
|
||||||
|
|
||||||
|
```
|
||||||
|
#footer p a {
|
||||||
|
background: none !important;
|
||||||
|
padding-left: 0px !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
input {
|
||||||
|
font-family: Verdana, Arial;
|
||||||
|
font-size: 10px;
|
||||||
|
color: #595441;
|
||||||
|
background-color: #FFFFFF;
|
||||||
|
border: 1px solid #88c0eb;
|
||||||
|
margin: 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#error-message {
|
||||||
|
padding: 10px;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
<!-- footer -->
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧑💻 Consulting and technical support
|
||||||
|
* For personal support and queries, please submit a new issue to have it addressed.
|
||||||
|
* For commercial related questions, please [**contact me**][ivancarlos] for consulting costs.
|
||||||
|
|
||||||
|
## 🩷 Project support
|
||||||
|
| If you found this project helpful, consider |
|
||||||
|
| :---: |
|
||||||
|
[**buying me a coffee**][buymeacoffee], [**donate by paypal**][paypal], [**sponsor this project**][sponsor] or just [**leave a star**](../..)⭐
|
||||||
|
|Thanks for your support, it is much appreciated!|
|
||||||
|
|
||||||
|
[cc]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project
|
||||||
|
[contributing]: https://docs.github.com/en/articles/setting-guidelines-for-repository-contributors
|
||||||
|
[security]: https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository
|
||||||
|
[support]: https://docs.github.com/en/articles/adding-support-resources-to-your-project
|
||||||
|
[it]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
|
||||||
|
[prt]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
|
||||||
|
[funding]: https://docs.github.com/en/articles/displaying-a-sponsor-button-in-your-repository
|
||||||
|
[ivancarlos]: https://ivancarlos.it
|
||||||
|
[buymeacoffee]: https://www.buymeacoffee.com/ivancarlos
|
||||||
|
[paypal]: https://icc.gg/donate
|
||||||
|
[sponsor]: https://github.com/sponsors/ivancarlosti
|
||||||
|
|||||||
4
manifest.json
Normal file
4
manifest.json
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"version": "1.2.18",
|
||||||
|
"author": "Ivan Carlos"
|
||||||
|
}
|
||||||
166
plugin.php
Normal file
166
plugin.php
Normal file
@@ -0,0 +1,166 @@
|
|||||||
|
<?php
|
||||||
|
/*
|
||||||
|
Plugin Name: ICC Webmaster Settings
|
||||||
|
Plugin URI: https://github.com/ivancarlosti/yourlsiccwebmastersettings
|
||||||
|
Description: Change Logo, Title, Page Footer, add custom CSS, and customize favicon lines
|
||||||
|
Version: 1.01
|
||||||
|
Author: Ivan Carlos
|
||||||
|
Author URI: https://ivancarlos.com.br/
|
||||||
|
*/
|
||||||
|
|
||||||
|
// No direct call
|
||||||
|
if( !defined( 'YOURLS_ABSPATH' ) ) die();
|
||||||
|
|
||||||
|
// Register unified config page
|
||||||
|
yourls_add_action( 'plugins_loaded', 'icc_config_add_page' );
|
||||||
|
function icc_config_add_page() {
|
||||||
|
yourls_register_plugin_page( 'icc_logo_title_footer_favicon_config', 'Webmaster Settings', 'icc_config_do_page' );
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle and display unified config page
|
||||||
|
function icc_config_do_page() {
|
||||||
|
if( isset( $_POST['icc_submit'] ) ) icc_config_update_option();
|
||||||
|
|
||||||
|
// Options
|
||||||
|
$icc_logo_imageurl = yourls_get_option( 'icc_logo_imageurl' );
|
||||||
|
$icc_logo_imageurl_tag = yourls_get_option( 'icc_logo_imageurl_tag' );
|
||||||
|
$icc_logo_imageurl_title = yourls_get_option( 'icc_logo_imageurl_title' );
|
||||||
|
$icc_title_custom = yourls_get_option( 'icc_title_custom' );
|
||||||
|
$icc_footer_text = yourls_get_option( 'icc_footer_text' );
|
||||||
|
if ($icc_footer_text === false) $icc_footer_text = '';
|
||||||
|
$footer_text_escaped = htmlspecialchars($icc_footer_text);
|
||||||
|
|
||||||
|
// Custom CSS option
|
||||||
|
$icc_custom_css = yourls_get_option( 'icc_custom_css' );
|
||||||
|
if ($icc_custom_css === false) $icc_custom_css = '';
|
||||||
|
$custom_css_escaped = htmlspecialchars($icc_custom_css);
|
||||||
|
|
||||||
|
$defaults = [
|
||||||
|
'favicon_icon32' => '',
|
||||||
|
'favicon_icon16' => '',
|
||||||
|
'favicon_shortcut_icon' => '',
|
||||||
|
];
|
||||||
|
$favicon_options = [];
|
||||||
|
foreach ($defaults as $key => $default_value) {
|
||||||
|
$val = yourls_get_option($key);
|
||||||
|
if ($val === false) $val = $default_value;
|
||||||
|
$favicon_options[$key] = $val;
|
||||||
|
}
|
||||||
|
$escape_attr = function($str) {
|
||||||
|
return htmlspecialchars($str, ENT_QUOTES | ENT_HTML5);
|
||||||
|
};
|
||||||
|
|
||||||
|
echo <<<HTML
|
||||||
|
<h2>Webmaster Settings</h2>
|
||||||
|
<form method="post">
|
||||||
|
<h3>Logo Settings</h3>
|
||||||
|
<p><label for="icc_logo_imageurl" style="display: inline-block; width: 200px;">Image URL</label>
|
||||||
|
<input type="text" id="icc_logo_imageurl" name="icc_logo_imageurl" value="{$escape_attr($icc_logo_imageurl)}" size="80" /></p>
|
||||||
|
<p><label for="icc_logo_imageurl_tag" style="display: inline-block; width: 200px;">Image ALT tag</label>
|
||||||
|
<input type="text" id="icc_logo_imageurl_tag" name="icc_logo_imageurl_tag" value="{$escape_attr($icc_logo_imageurl_tag)}" size="80" /></p>
|
||||||
|
<p><label for="icc_logo_imageurl_title" style="display: inline-block; width: 200px;">Image Title</label>
|
||||||
|
<input type="text" id="icc_logo_imageurl_title" name="icc_logo_imageurl_title" value="{$escape_attr($icc_logo_imageurl_title)}" size="80" /></p>
|
||||||
|
|
||||||
|
<h3>Title Settings</h3>
|
||||||
|
<p><label for="icc_title_custom" style="display: inline-block; width: 200px;">Custom Title</label>
|
||||||
|
<input type="text" id="icc_title_custom" name="icc_title_custom" value="{$escape_attr($icc_title_custom)}" size="80" /></p>
|
||||||
|
|
||||||
|
<h3>Footer Settings</h3>
|
||||||
|
<p><label for="icc_footer_text" style="display: inline-block; width: 200px; vertical-align: top;">Footer Text (HTML allowed)</label>
|
||||||
|
<textarea id="icc_footer_text" name="icc_footer_text" rows="5" cols="80" style="vertical-align: top;">{$footer_text_escaped}</textarea></p>
|
||||||
|
|
||||||
|
<h3>Custom CSS</h3>
|
||||||
|
<p><label for="icc_custom_css" style="display: inline-block; width: 200px; vertical-align: top;">Custom CSS<br>
|
||||||
|
<span style="color:#666;font-size:90%;">(Enter raw CSS. It will be added inside a <code><style></code> tag.)</span></label>
|
||||||
|
<textarea id="icc_custom_css" name="icc_custom_css" rows="5" cols="80" style="vertical-align: top;">{$custom_css_escaped}</textarea></p>
|
||||||
|
|
||||||
|
<h3>Favicon Lines Settings</h3>
|
||||||
|
<p><label for="favicon_icon32" style="display: inline-block; width: 200px;">Icon PNG 32x32 URL</label>
|
||||||
|
<input type="text" id="favicon_icon32" name="favicon_icon32" value="{$escape_attr($favicon_options['favicon_icon32'])}" size="80" /></p>
|
||||||
|
<p><label for="favicon_icon16" style="display: inline-block; width: 200px;">Icon PNG 16x16 URL</label>
|
||||||
|
<input type="text" id="favicon_icon16" name="favicon_icon16" value="{$escape_attr($favicon_options['favicon_icon16'])}" size="80" /></p>
|
||||||
|
<p><label for="favicon_shortcut_icon" style="display: inline-block; width: 200px;">Shortcut Icon (favicon.ico) URL</label>
|
||||||
|
<input type="text" id="favicon_shortcut_icon" name="favicon_shortcut_icon" value="{$escape_attr($favicon_options['favicon_shortcut_icon'])}" size="80" /></p>
|
||||||
|
|
||||||
|
<p><input type="submit" name="icc_submit" value="Update values" /></p>
|
||||||
|
</form>
|
||||||
|
<hr style="margin-top: 40px" />
|
||||||
|
<p><strong><a href="https://ivancarlos.me/" target="_blank">Ivan Carlos</a></strong> »
|
||||||
|
<a href="http://github.com/ivancarlosti/" target="_blank">GitHub</a> »
|
||||||
|
<a href="https://buymeacoffee.com/ivancarlos" target="_blank">Buy Me a Coffee</a></p>
|
||||||
|
HTML;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update options
|
||||||
|
function icc_config_update_option() {
|
||||||
|
$fields_logo = ['icc_logo_imageurl', 'icc_logo_imageurl_tag', 'icc_logo_imageurl_title'];
|
||||||
|
foreach ($fields_logo as $key) {
|
||||||
|
if (isset($_POST[$key])) yourls_update_option($key, strval($_POST[$key]));
|
||||||
|
}
|
||||||
|
if (isset($_POST['icc_title_custom'])) yourls_update_option('icc_title_custom', strval($_POST['icc_title_custom']));
|
||||||
|
if (isset($_POST['icc_footer_text'])) yourls_update_option('icc_footer_text', $_POST['icc_footer_text']);
|
||||||
|
if (isset($_POST['icc_custom_css'])) yourls_update_option('icc_custom_css', $_POST['icc_custom_css']);
|
||||||
|
$fields_favicon = ['favicon_icon32','favicon_icon16','favicon_shortcut_icon'];
|
||||||
|
foreach ($fields_favicon as $key) {
|
||||||
|
if (isset($_POST[$key])) yourls_update_option($key, strval($_POST[$key]));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Show custom logo
|
||||||
|
yourls_add_filter( 'pre_html_logo', 'icc_hideoriginallogo' );
|
||||||
|
function icc_hideoriginallogo() {
|
||||||
|
echo '<span id="hideYourlsLogo" style="display:none">';
|
||||||
|
}
|
||||||
|
yourls_add_filter( 'html_logo', 'icc_logo' );
|
||||||
|
function icc_logo() {
|
||||||
|
echo '</span>';
|
||||||
|
echo '<h1 id="yourls.logo">';
|
||||||
|
echo '<a href="'.yourls_admin_url( 'index.php' ).'" title="'.yourls_get_option( 'icc_logo_imageurl_title' ).'"><span>';
|
||||||
|
echo '<img src="'.yourls_get_option( 'icc_logo_imageurl' ).'" alt="'.yourls_get_option( 'icc_logo_imageurl_tag' ).'" title="'.yourls_get_option( 'icc_logo_imageurl_title' ).'" border="0" style="border: 0px; max-width: 100px;" /></a>';
|
||||||
|
echo '</h1>';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Show custom title
|
||||||
|
yourls_add_filter( 'html_title', 'icc_change_title' );
|
||||||
|
function icc_change_title( $value ) {
|
||||||
|
$custom = yourls_get_option( 'icc_title_custom' );
|
||||||
|
if ($custom !== '') return $custom;
|
||||||
|
return $value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Replace footer text with custom footer from option
|
||||||
|
yourls_add_filter( 'html_footer_text', 'icc_change_footer' );
|
||||||
|
function icc_change_footer( $value ) {
|
||||||
|
$custom_footer = yourls_get_option( 'icc_footer_text' );
|
||||||
|
if ( !empty($custom_footer) ) return $custom_footer;
|
||||||
|
return $value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Output favicon lines (only if set)
|
||||||
|
yourls_add_filter('shunt_html_favicon', 'icc_plugin_favicon');
|
||||||
|
function icc_plugin_favicon() {
|
||||||
|
$opts = [
|
||||||
|
'favicon_icon32' => yourls_get_option('favicon_icon32'),
|
||||||
|
'favicon_icon16' => yourls_get_option('favicon_icon16'),
|
||||||
|
'favicon_shortcut_icon' => yourls_get_option('favicon_shortcut_icon'),
|
||||||
|
];
|
||||||
|
if (!empty($opts['favicon_icon32'])) {
|
||||||
|
echo '<link rel="icon" type="image/png" sizes="32x32" href="' . htmlspecialchars($opts['favicon_icon32'], ENT_QUOTES | ENT_HTML5) . '">'."\n";
|
||||||
|
}
|
||||||
|
if (!empty($opts['favicon_icon16'])) {
|
||||||
|
echo '<link rel="icon" type="image/png" sizes="16x16" href="' . htmlspecialchars($opts['favicon_icon16'], ENT_QUOTES | ENT_HTML5) . '">'."\n";
|
||||||
|
}
|
||||||
|
if (!empty($opts['favicon_shortcut_icon'])) {
|
||||||
|
echo '<link rel="shortcut icon" href="' . htmlspecialchars($opts['favicon_shortcut_icon'], ENT_QUOTES | ENT_HTML5) . '">'."\n";
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Output custom CSS if set
|
||||||
|
yourls_add_action('html_head', 'icc_print_custom_css');
|
||||||
|
function icc_print_custom_css() {
|
||||||
|
$css = yourls_get_option('icc_custom_css');
|
||||||
|
if ($css !== false && trim($css) !== '') {
|
||||||
|
echo "<style>\n" . $css . "\n</style>\n";
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user