├── heroku.yml
├── requirements.txt
├── example.env
├── main.py
├── Dockerfile
├── config.py
├── VCBot
├── queues.py
├── playlist.py
├── playfrom.py
├── ping.py
├── handlers.py
├── skip.py
├── play.py
└── vplay.py
├── .github
└── workflows
│ ├── python-publish.yml
│ └── main.yml
├── app.json
├── README.md
└── LICENSE
/heroku.yml:
--------------------------------------------------------------------------------
1 | build:
2 | docker:
3 | worker: Dockerfile
4 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | TgCrypto
2 | git+https://github.com/pyrogram/pyrogram@master
3 | py-tgcalls==0.8.1rc1
4 | asyncio
5 | youtube-search-python
6 | youtube-dl
7 | python-dotenv
8 |
--------------------------------------------------------------------------------
/example.env:
--------------------------------------------------------------------------------
1 | # For Local Deploys only
2 | # Fill it in and rename it to .env if you are deploying on a Local Machine / VPS
3 |
4 |
5 | API_ID=6
6 | API_HASH=eb06d4abfb49dc3eeb1aeb98ae0f581e
7 | SESSION=pyrogram_string_session
8 | HNDLR=!
9 |
10 |
--------------------------------------------------------------------------------
/main.py:
--------------------------------------------------------------------------------
1 | import os
2 | from pyrogram import Client, idle
3 | from pytgcalls import PyTgCalls
4 | from pytgcalls import idle as pyidle
5 | from config import bot, call_py
6 |
7 | bot.start()
8 | print("UserBot Started")
9 | call_py.start()
10 | print("Vc Client Started")
11 | pyidle()
12 | idle()
13 |
--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM python:3.9
2 |
3 | RUN apt update && apt upgrade -y
4 | RUN apt install python3-pip -y
5 | RUN apt install ffmpeg -y
6 |
7 | RUN curl -sL https://deb.nodesource.com/setup_16.x | bash -
8 | RUN apt-get install -y nodejs
9 | RUN npm i -g npm
10 |
11 | RUN mkdir /app/
12 | COPY . /app
13 | WORKDIR /app
14 |
15 | RUN pip3 install --upgrade pip
16 | RUN pip3 install -U -r requirements.txt
17 |
18 | CMD python3 main.py
19 |
--------------------------------------------------------------------------------
/config.py:
--------------------------------------------------------------------------------
1 | import os
2 | from dotenv import load_dotenv
3 | from pyrogram import Client, filters
4 | from pytgcalls import PyTgCalls
5 |
6 | # For Local Deploy
7 | if os.path.exists(".env"):
8 | load_dotenv(".env")
9 |
10 | # Necessary Vars
11 | API_ID = int(os.getenv("API_ID", "6"))
12 | API_HASH = os.getenv("API_HASH", "eb06d4abfb49dc3eeb1aeb98ae0f581e")
13 | SESSION = os.getenv("SESSION")
14 | HNDLR = os.getenv("HNDLR", "!")
15 |
16 |
17 | contact_filter = filters.create(
18 | lambda _, __, message:
19 | (message.from_user and message.from_user.is_contact) or message.outgoing
20 | )
21 |
22 | bot = Client(SESSION, API_ID, API_HASH, plugins=dict(root="VCBot"))
23 | call_py = PyTgCalls(bot)
24 |
--------------------------------------------------------------------------------
/VCBot/queues.py:
--------------------------------------------------------------------------------
1 | QUEUE = {}
2 |
3 | def add_to_queue(chat_id, songname, link, ref, type, quality):
4 | if chat_id in QUEUE:
5 | chat_queue = QUEUE[chat_id]
6 | chat_queue.append([songname, link, ref, type, quality])
7 | return int(len(chat_queue)-1)
8 | else:
9 | QUEUE[chat_id] = [[songname, link, ref, type, quality]]
10 |
11 | def get_queue(chat_id):
12 | if chat_id in QUEUE:
13 | chat_queue = QUEUE[chat_id]
14 | return chat_queue
15 | else:
16 | return 0
17 |
18 | def pop_an_item(chat_id):
19 | if chat_id in QUEUE:
20 | chat_queue = QUEUE[chat_id]
21 | chat_queue.pop(0)
22 | return 1
23 | else:
24 | return 0
25 |
26 | def clear_queue(chat_id):
27 | if chat_id in QUEUE:
28 | QUEUE.pop(chat_id)
29 | return 1
30 | else:
31 | return 0
32 |
--------------------------------------------------------------------------------
/VCBot/playlist.py:
--------------------------------------------------------------------------------
1 | from pyrogram import Client
2 | from pyrogram import filters
3 | from pyrogram.types import Message
4 | from VCBot.queues import QUEUE, get_queue
5 | from config import HNDLR, contact_filter
6 |
7 | @Client.on_message(filters.command(['playlist', 'queue'], prefixes=f"{HNDLR}"))
8 | async def playlist(client, m: Message):
9 | chat_id = m.chat.id
10 | if chat_id in QUEUE:
11 | chat_queue = get_queue(chat_id)
12 | if len(chat_queue)==1:
13 | await m.reply(f"**🎧 NOW PLAYING:** \n[{chat_queue[0][0]}]({chat_queue[0][2]}) | `{chat_queue[0][3]}`", disable_web_page_preview=True)
14 | else:
15 | QUE = f"**🎧 NOW PLAYING:** \n[{chat_queue[0][0]}]({chat_queue[0][2]}) | `{chat_queue[0][3]}` \n\n**⏯ PLAYLIST:**"
16 | l = len(chat_queue)
17 | for x in range (1, l):
18 | hmm = chat_queue[x][0]
19 | hmmm = chat_queue[x][2]
20 | hmmmm = chat_queue[x][3]
21 | QUE = QUE + "\n" + f"**#{x}** - [{hmm}]({hmmm}) | `{hmmmm}`"
22 | await m.reply(QUE, disable_web_page_preview=True)
23 | else:
24 | await m.reply("`Nothing is Streaming`")
25 |
--------------------------------------------------------------------------------
/.github/workflows/python-publish.yml:
--------------------------------------------------------------------------------
1 | # This workflow will upload a Python Package using Twine when a release is created
2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
3 |
4 | # This workflow uses actions that are not certified by GitHub.
5 | # They are provided by a third-party and are governed by
6 | # separate terms of service, privacy policy, and support
7 | # documentation.
8 |
9 | name: Upload Python Package
10 |
11 | on:
12 | release:
13 | types: [published]
14 |
15 | jobs:
16 | deploy:
17 |
18 | runs-on: ubuntu-latest
19 |
20 | steps:
21 | - uses: actions/checkout@v2
22 | - name: Set up Python
23 | uses: actions/setup-python@v2
24 | with:
25 | python-version: '3.x'
26 | - name: Install dependencies
27 | run: |
28 | python -m pip install --upgrade pip
29 | pip install build
30 | - name: Build package
31 | run: python -m build
32 | - name: Publish package
33 | uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
34 | with:
35 | user: __token__
36 | password: ${{ secrets.PYPI_API_TOKEN }}
37 |
--------------------------------------------------------------------------------
/app.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "TG-MusicPlayer",
3 | "description": "A Telegram Userbot to play Songs in Voice Chat",
4 | "logo": "https://telegra.ph/file/12a12ad933f3f972deb61.jpg",
5 | "keywords": [
6 | "Telegram",
7 | "VCBot",
8 | "MusicPlayer"
9 | ],
10 | "repository": "https://github.com/Lost-In-Dark/TG-MusicPlayer",
11 | "env": {
12 | "SESSION": {
13 | "description": "Pyrogram String Session",
14 | "required": true
15 | },
16 | "API_ID": {
17 | "description": "my.telegram.org",
18 | "required": true
19 | },
20 | "API_HASH": {
21 | "description": "my.telegram.org",
22 | "required": true
23 | },
24 | "HNDLR": {
25 | "description": "Handler | Default (!)",
26 | "value": "!",
27 | "required": false
28 | }
29 | },
30 | "addons": [],
31 | "buildpacks": [
32 | {
33 | "url": "heroku/python"
34 | },
35 | {
36 | "url": "https://github.com/jonathanong/heroku-buildpack-ffmpeg-latest"
37 | }
38 | ],
39 | "formation": {
40 | "worker": {
41 | "quantity": 1,
42 | "size": "free"
43 | }
44 | },
45 | "stack": "container"
46 | }
47 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # TG-MusicPlayer
2 | A Telegram Userbot to play Audio and Video songs / files in Telegram Voice Chats.
3 |
4 | It's made with [PyTgCalls](https://github.com/pytgcalls/pytgcalls) and [Pyrogram](https://github.com/pyrogram/pyrogram)
5 |
6 |
7 | ## Requirements
8 | - Python 3.8+
9 | - FFMPEG
10 | - Nodejs v16+
11 |
12 |
13 | ## Deployment
14 |
15 | ### Heroku
16 | [](https://heroku.com/deploy)
17 |
18 | ### Local Deploy
19 | 1) Installing NodeJS
20 | ```bash
21 | curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
22 | sudo apt-get install -y nodejs
23 | ```
24 |
25 | 2) Installing FFMPEG and Git
26 | ```bash
27 | sudo apt-get install git ffmpeg -y
28 | ```
29 |
30 | 3) Cloning the Repo
31 | ```bash
32 | git clone https://github.com/Lost-In-Dark/TG-MusicPlayer
33 | cd TG-MusicPlayer
34 | ```
35 |
36 | 4) Rename `example.env` to `.env` and Fill in the Environment Variables
37 |
38 | 5) Installing Requirements
39 | ```bash
40 | pip3 install -U -r requirements.txt
41 | ```
42 |
43 | 6) Run the Bot
44 | ```bash
45 | python3 main.py
46 | ```
47 |
48 |
49 | ## Environment Variables
50 | - `API_ID`
51 | - `API_HASH`
52 | - `SESSION` - A Pyrogram String Session. Get one from [Here](https://replit.com/@dashezup/generate-pyrogram-session-string)
53 | - `HNDLR` - Your Userbot Handler (Default is !)
54 |
55 |
56 | ## Commands and Usage
57 | 1) Start the Userbot, check if the Userbot is running by `!ping`.
58 | 2) Commands of this userbot are accessible to and can be used by the Account itself and it's Contacts.
59 | 3) Check `!help` for commands.
60 |
61 |
62 | ## Credits ✨
63 | - [Dan](https://github.com/delivrance) for [Pyrogram](https://github.com/pyrogram/pyrogram)
64 | - [Laky](https://github.com/Laky-64) for [PyTgCalls](https://github.com/pytgcalls/pytgcalls)
65 |
--------------------------------------------------------------------------------
/VCBot/playfrom.py:
--------------------------------------------------------------------------------
1 | import os
2 | import asyncio
3 | from pyrogram import Client
4 | from VCBot.queues import QUEUE, add_to_queue
5 | from config import bot, call_py, HNDLR, contact_filter
6 | from pyrogram import filters
7 | from pyrogram.types import Message
8 | from pytgcalls import StreamType
9 | from pytgcalls.types.input_stream import AudioPiped
10 |
11 | @Client.on_message(filters.command(['playfrom'], prefixes=f"{HNDLR}"))
12 | async def playfrom(client, m: Message):
13 | chat_id = m.chat.id
14 | if len(m.command) < 2:
15 | await m.reply("**USAGE:** \n\n`/playfrom [chat_id/username]` \n`/playfrom [chat_id/username] ; [no. of songs]`")
16 | else:
17 | args = m.text.split(maxsplit=1)[1]
18 | if ";" in args:
19 | chat = args.split(";")[0]
20 | limit = int(args.split(";")[1])
21 | else:
22 | chat = args
23 | limit = 10
24 | hmm = await m.reply(f"Searching the last **{limit}** Songs from `{chat}`")
25 | try:
26 | async for x in bot.search_messages(chat, limit=limit, filter="audio"):
27 | location = await x.download()
28 | if x.audio.title:
29 | songname = x.audio.title[:30] + "..."
30 | else:
31 | songname = x.audio.file_name[:30] + "..."
32 | link = x.link
33 | if chat_id in QUEUE:
34 | add_to_queue(chat_id, songname, location, link, "Audio", 0)
35 | else:
36 | await call_py.join_group_call(
37 | chat_id,
38 | AudioPiped(
39 | location
40 | ),
41 | stream_type=StreamType().pulse_stream,
42 | )
43 | add_to_queue(chat_id, songname, location, link, "Audio", 0)
44 | await m.reply(f"**Started Playing Songs from {chat} ▶** \n**🎧 SONG** : [{songname}]({link}) \n**💬 CHAT** : `{chat_id}`", disable_web_page_preview=True)
45 | await hmm.delete()
46 | await m.reply(f"Added **{limit}** SONGS to Queue")
47 | except Exception as e:
48 | await hmm.edit(f"**ERROR** \n`{e}`")
49 |
--------------------------------------------------------------------------------
/VCBot/ping.py:
--------------------------------------------------------------------------------
1 | import os
2 | import sys
3 | import asyncio
4 | from pyrogram import Client
5 | from pyrogram import filters
6 | from pyrogram.types import Message
7 | from config import bot, call_py, HNDLR, contact_filter
8 | from time import time
9 | from datetime import datetime
10 |
11 | # System Uptime
12 | START_TIME = datetime.utcnow()
13 | TIME_DURATION_UNITS = (
14 | ('Week', 60 * 60 * 24 * 7),
15 | ('Day', 60 * 60 * 24),
16 | ('Hour', 60 * 60),
17 | ('Min', 60),
18 | ('Sec', 1)
19 | )
20 | async def _human_time_duration(seconds):
21 | if seconds == 0:
22 | return 'inf'
23 | parts = []
24 | for unit, div in TIME_DURATION_UNITS:
25 | amount, seconds = divmod(int(seconds), div)
26 | if amount > 0:
27 | parts.append('{} {}{}'
28 | .format(amount, unit, "" if amount == 1 else "s"))
29 | return ', '.join(parts)
30 |
31 |
32 | @Client.on_message(contact_filter & filters.command(['ping'], prefixes=f"{HNDLR}"))
33 | async def ping(client, m: Message):
34 | start = time()
35 | current_time = datetime.utcnow()
36 | m_reply = await m.reply_text("`...`")
37 | delta_ping = time() - start
38 | uptime_sec = (current_time - START_TIME).total_seconds()
39 | uptime = await _human_time_duration(int(uptime_sec))
40 | await m_reply.edit(f"`{delta_ping * 1000:.3f} ms` \n**Uptime ⏳** - `{uptime}`")
41 |
42 | @Client.on_message(contact_filter & filters.command(['restart'], prefixes=f"{HNDLR}"))
43 | async def restart(client, m: Message):
44 | await m.reply("`Restarting...`")
45 | os.execl(sys.executable, sys.executable, *sys.argv)
46 | # You probably don't need it but whatever
47 | quit()
48 |
49 | @Client.on_message(contact_filter & filters.command(['help'], prefixes=f"{HNDLR}"))
50 | async def help(client, m: Message):
51 | HELP = f"**HELP MENU 🛠** \n\n__USER COMMANDS__ (Anyone can Use): \n`{HNDLR}play` \n`{HNDLR}vplay` \n`{HNDLR}stream` (For Radio links) \n`{HNDLR}vstream` (For .m3u8 / live links) \n`{HNDLR}playfrom [channel] ; [n]` - Plays last n songs from channel \n`{HNDLR}playlist` / `{HNDLR}queue` \n\n__SUDO COMMANDS__ (Can only be accessed by You and Your Contacts): \n`{HNDLR}ping` \n`{HNDLR}skip` \n`{HNDLR}pause` and `{HNDLR}resume` \n`{HNDLR}stop` / `{HNDLR}end` \n`{HNDLR}help` \n`{HNDLR}restart`"
52 | await m.reply(HELP)
53 |
--------------------------------------------------------------------------------
/VCBot/handlers.py:
--------------------------------------------------------------------------------
1 | from VCBot.queues import QUEUE, get_queue, pop_an_item, clear_queue
2 | from config import bot, call_py
3 | from pytgcalls import StreamType
4 | from pyrogram import Client
5 | from pyrogram.raw.base import Update
6 | from pytgcalls.types.input_stream import AudioPiped, AudioVideoPiped
7 | from pytgcalls.types.stream import StreamAudioEnded
8 | from pytgcalls.types.input_stream.quality import HighQualityAudio
9 | from pytgcalls.types.input_stream.quality import HighQualityVideo, MediumQualityVideo, LowQualityVideo
10 |
11 | async def skip_current_song(chat_id):
12 | if chat_id in QUEUE:
13 | chat_queue = get_queue(chat_id)
14 | if len(chat_queue)==1:
15 | await call_py.leave_group_call(chat_id)
16 | clear_queue(chat_id)
17 | return 1
18 | else:
19 | songname = chat_queue[1][0]
20 | url = chat_queue[1][1]
21 | link = chat_queue[1][2]
22 | type = chat_queue[1][3]
23 | Q = chat_queue[1][4]
24 | if type=="Audio":
25 | await call_py.change_stream(
26 | chat_id,
27 | AudioPiped(
28 | url,
29 | )
30 | )
31 | elif type=="Video":
32 | if Q==720:
33 | hm = HighQualityVideo()
34 | elif Q==480:
35 | hm = MediumQualityVideo()
36 | elif Q==360:
37 | hm = LowQualityVideo()
38 | await call_py.change_stream(
39 | chat_id,
40 | AudioVideoPiped(
41 | url,
42 | HighQualityAudio(),
43 | hm
44 | )
45 | )
46 | pop_an_item(chat_id)
47 | return [songname, link, type]
48 | else:
49 | return 0
50 |
51 | async def skip_item(chat_id, h):
52 | if chat_id in QUEUE:
53 | chat_queue = get_queue(chat_id)
54 | try:
55 | x = int(h)
56 | songname = chat_queue[x][0]
57 | chat_queue.pop(x)
58 | return songname
59 | except Exception as e:
60 | print(e)
61 | return 0
62 | else:
63 | return 0
64 |
65 |
66 | @call_py.on_stream_end()
67 | async def on_end_handler(client, update: Update):
68 | if isinstance(update, StreamAudioEnded):
69 | chat_id = update.chat_id
70 | print(chat_id)
71 | op = await skip_current_song(chat_id)
72 | if op==1:
73 | await bot.send_message(chat_id, "`Queue is Empty, Leaving Voice Chat...`")
74 | else:
75 | await bot.send_message(chat_id, f"**🎧 Now Playing** \n[{op[0]}]({op[1]}) | `{op[2]}`", disable_web_page_preview=True)
76 | else:
77 | pass
78 |
--------------------------------------------------------------------------------
/VCBot/skip.py:
--------------------------------------------------------------------------------
1 | from pyrogram import Client
2 | from pyrogram import filters
3 | from pyrogram.types import Message
4 | from config import bot, call_py, HNDLR, contact_filter
5 | from VCBot.handlers import skip_current_song, skip_item
6 | from VCBot.queues import QUEUE, clear_queue
7 |
8 | @Client.on_message(contact_filter & filters.command(['skip'], prefixes=f"{HNDLR}"))
9 | async def skip(client, m: Message):
10 | chat_id = m.chat.id
11 | if len(m.command) < 2:
12 | op = await skip_current_song(chat_id)
13 | if op==0:
14 | await m.reply("`Nothing Is Playing`")
15 | elif op==1:
16 | await m.reply("`Queue is Empty, Leaving Voice Chat...`")
17 | else:
18 | await m.reply(f"**Skipped ⏭** \n**🎧 Now Playing** - [{op[0]}]({op[1]}) | `{op[2]}`", disable_web_page_preview=True)
19 | else:
20 | skip = m.text.split(None, 1)[1]
21 | OP = "**Removed the following songs from Queue:-**"
22 | if chat_id in QUEUE:
23 | items = [int(x) for x in skip.split(" ") if x.isdigit()]
24 | items.sort(reverse=True)
25 | for x in items:
26 | if x==0:
27 | pass
28 | else:
29 | hm = await skip_item(chat_id, x)
30 | if hm==0:
31 | pass
32 | else:
33 | OP = OP + "\n" + f"**#{x}** - {hm}"
34 | await m.reply(OP)
35 |
36 | @Client.on_message(contact_filter & filters.command(['end', 'stop'], prefixes=f"{HNDLR}"))
37 | async def stop(client, m: Message):
38 | chat_id = m.chat.id
39 | if chat_id in QUEUE:
40 | try:
41 | await call_py.leave_group_call(chat_id)
42 | clear_queue(chat_id)
43 | await m.reply("**Stopped Streaming ⏹️**")
44 | except Exception as e:
45 | await m.reply(f"**ERROR** \n`{e}`")
46 | else:
47 | await m.reply("`Nothing is Streaming`")
48 |
49 | @Client.on_message(contact_filter & filters.command(['pause'], prefixes=f"{HNDLR}"))
50 | async def pause(client, m: Message):
51 | chat_id = m.chat.id
52 | if chat_id in QUEUE:
53 | try:
54 | await call_py.pause_stream(chat_id)
55 | await m.reply("**Paused Streaming ⏸️**")
56 | except Exception as e:
57 | await m.reply(f"**ERROR** \n`{e}`")
58 | else:
59 | await m.reply("`Nothing is Streaming`")
60 |
61 | @Client.on_message(contact_filter & filters.command(['resume'], prefixes=f"{HNDLR}"))
62 | async def resume(client, m: Message):
63 | chat_id = m.chat.id
64 | if chat_id in QUEUE:
65 | try:
66 | await call_py.resume_stream(chat_id)
67 | await m.reply("**Resumed Streaming ▶**")
68 | except Exception as e:
69 | await m.reply(f"**ERROR** \n`{e}`")
70 | else:
71 | await m.reply("`Nothing is Streaming`")
72 |
--------------------------------------------------------------------------------
/.github/workflows/main.yml:
--------------------------------------------------------------------------------
1 | name: Friday
2 |
3 | on:
4 | push:
5 | branches: [ main ]
6 | paths-ignore: 'README.md'
7 | workflow_dispatch:
8 |
9 | env:
10 | GitHubMail: "iam.pro2@outlook.com"
11 | GitHubName: "TechiError"
12 | PIP_NO_CACHE_DIR: 1
13 | LANG: "C.UTF-8"
14 | GOOGLE_CHROME_DRIVER: "/usr/bin/chromedriver"
15 | GOOGLE_CHROME_BIN: "/usr/bin/google-chrome-stable"
16 | jobs:
17 | build:
18 | runs-on: ubuntu-20.04
19 |
20 | steps:
21 | - name: Setup
22 | run: |
23 | sudo su
24 | sudo -i
25 | sudo rm -rf /usr/local/bin/npm /usr/local/share/man/man1/node* /usr/local/lib/dtrace/node.d ~/.npm ~/.node-gyp /opt/local/bin/node opt/local/include/node /opt/local/lib/node_modules
26 | sudo rm -rf /usr/local/lib/node*
27 | sudo rm -rf /usr/local/include/node*
28 | sudo rm -rf /usr/local/bin/node*
29 | sudo apt install software-properties-common
30 | sudo add-apt-repository ppa:deadsnakes/ppa
31 | sudo apt install python3.9
32 | sudo rm -rf /usr/bin/python
33 | if sudo [ ! -e /usr/bin/python ]; then sudo ln -sf /usr/bin/python3 /usr/bin/python; fi
34 | git config --global user.email ${GitHubMail}
35 | git config --global user.name ${GitHubName}
36 | git config --global credential.helper store
37 | sudo echo "https://${GitHubName}:${{ secrets.GH_TOKEN }}@github.com" > ~/.git-credentials
38 | sudo git clone https://github.com/TechiError/TG-MusicPlayer /app/
39 | cd /app/
40 | sudo sed -i.bak 's/us-west-2\.ec2\.//' /etc/apt/sources.list
41 | sudo curl -sL https://deb.nodesource.com/setup_16.x -o nodesource_setup.sh
42 | sudo bash nodesource_setup.sh
43 | sudo apt-get install nodejs
44 | sudo apt -qq update && apt -qq upgrade -y && \
45 | sudo apt -qq install -y --no-install-recommends ffmpeg neofetch
46 | sudo rm -rf /var/lib/apt/lists /var/cache/apt/archives /tmp/*
47 | cd /app/
48 | sudo pip3 install -U setuptools wheel && \
49 | sudo pip3 install --no-cache-dir -r requirements.txt
50 | - name: Running Friday
51 | timeout-minutes: 350
52 | continue-on-error: true
53 | run: |
54 | sudo wget ${{ secrets.CREDS }} -P /app/
55 | cd /app/
56 | sudo python3 main.py
57 | - name: Loop workflow
58 | continue-on-error: true
59 | run: |
60 | git clone -b main https://${{ secrets.GH_TOKEN }}@github.com/${GITHUB_REPOSITORY} loop
61 | cd loop || exit 1
62 | echo $(( RANDOM - ( RANDOM % RANDOM ) )) > looper.txt
63 | git add looper.txt
64 | git commit -m "Workflow : Loop at $(date -u +%D-%T%P)"
65 | git push -q https://${{ secrets.GH_TOKEN }}@github.com/${GITHUB_REPOSITORY} HEAD:main
66 |
--------------------------------------------------------------------------------
/VCBot/play.py:
--------------------------------------------------------------------------------
1 | import os
2 | import re
3 | import asyncio
4 | from pyrogram import Client
5 | from VCBot.queues import QUEUE, add_to_queue
6 | from config import bot, call_py, HNDLR, contact_filter
7 | from pyrogram import filters
8 | from pyrogram.types import Message
9 | from pytgcalls import StreamType
10 | from pytgcalls.types.input_stream import AudioPiped
11 | from youtubesearchpython import VideosSearch
12 |
13 |
14 | def ytsearch(query):
15 | try:
16 | search = VideosSearch(query, limit=1)
17 | for r in search.result()["result"]:
18 | ytid = r['id']
19 | if len(r['title']) > 34:
20 | songname = r['title'][:35] + "..."
21 | else:
22 | songname = r['title']
23 | url = f"https://www.youtube.com/watch?v={ytid}"
24 | return [songname, url]
25 | except Exception as e:
26 | print(e)
27 | return 0
28 |
29 | # YTDL
30 | # https://github.com/pytgcalls/pytgcalls/blob/dev/example/youtube_dl/youtube_dl_example.py
31 | async def ytdl(link):
32 | proc = await asyncio.create_subprocess_exec(
33 | 'youtube-dl',
34 | '-g',
35 | '-f',
36 | # CHANGE THIS BASED ON WHAT YOU WANT
37 | 'bestaudio',
38 | f'{link}',
39 | stdout=asyncio.subprocess.PIPE,
40 | stderr=asyncio.subprocess.PIPE,
41 | )
42 | stdout, stderr = await proc.communicate()
43 | if stdout:
44 | return 1, stdout.decode().split('\n')[0]
45 | else:
46 | return 0, stderr.decode()
47 |
48 |
49 | @Client.on_message(filters.command(['play'], prefixes=f"{HNDLR}"))
50 | async def play(client, m: Message):
51 | replied = m.reply_to_message
52 | chat_id = m.chat.id
53 | if replied:
54 | if replied.audio or replied.voice:
55 | huehue = await replied.reply("`Downloading`")
56 | dl = await replied.download()
57 | link = replied.link
58 | if replied.audio:
59 | if replied.audio.title:
60 | songname = replied.audio.title[:35] + "..."
61 | else:
62 | songname = replied.audio.file_name[:35] + "..."
63 | elif replied.voice:
64 | songname = "Voice Note"
65 | if chat_id in QUEUE:
66 | pos = add_to_queue(chat_id, songname, dl, link, "Audio", 0)
67 | await huehue.edit(f"Queued at **#{pos}**")
68 | else:
69 | await call_py.join_group_call(
70 | chat_id,
71 | AudioPiped(
72 | dl,
73 | ),
74 | stream_type=StreamType().pulse_stream,
75 | )
76 | add_to_queue(chat_id, songname, dl, link, "Audio", 0)
77 | await huehue.edit(f"**Started Playing Audio ▶** \n**🎧 SONG** : [{songname}]({link}) \n**💬 CHAT** : `{chat_id}`", disable_web_page_preview=True)
78 | else:
79 | if len(m.command) < 2:
80 | await m.reply("`Reply to an Audio File or give something to Search`")
81 | else:
82 | huehue = await m.reply("`Searching...`")
83 | query = m.text.split(None, 1)[1]
84 | search = ytsearch(query)
85 | if search==0:
86 | await huehue.edit("`Found Nothing for the Given Query`")
87 | else:
88 | songname = search[0]
89 | url = search[1]
90 | hm, ytlink = await ytdl(url)
91 | if hm==0:
92 | await huehue.edit(f"**YTDL ERROR ⚠️** \n\n`{ytlink}`")
93 | else:
94 | if chat_id in QUEUE:
95 | pos = add_to_queue(chat_id, songname, ytlink, url, "Audio", 0)
96 | await huehue.edit(f"Queued at **#{pos}**")
97 | else:
98 | try:
99 | await call_py.join_group_call(
100 | chat_id,
101 | AudioPiped(
102 | ytlink,
103 | ),
104 | stream_type=StreamType().pulse_stream,
105 | )
106 | add_to_queue(chat_id, songname, ytlink, url, "Audio", 0)
107 | await huehue.edit(f"**Started Playing Audio ▶** \n**🎧 SONG** : [{songname}]({url}) \n**💬 CHAT** : `{chat_id}`", disable_web_page_preview=True)
108 | except Exception as ep:
109 | await huehue.edit(f"`{ep}`")
110 |
111 | else:
112 | if len(m.command) < 2:
113 | await m.reply("`Reply to an Audio File or give something to Search`")
114 | else:
115 | huehue = await m.reply("`Searching...`")
116 | query = m.text.split(None, 1)[1]
117 | search = ytsearch(query)
118 | if search==0:
119 | await huehue.edit("`Found Nothing for the Given Query`")
120 | else:
121 | songname = search[0]
122 | url = search[1]
123 | hm, ytlink = await ytdl(url)
124 | if hm==0:
125 | await huehue.edit(f"**YTDL ERROR ⚠️** \n\n`{ytlink}`")
126 | else:
127 | if chat_id in QUEUE:
128 | pos = add_to_queue(chat_id, songname, ytlink, url, "Audio", 0)
129 | await huehue.edit(f"Queued at **#{pos}**")
130 | else:
131 | try:
132 | await call_py.join_group_call(
133 | chat_id,
134 | AudioPiped(
135 | ytlink,
136 | ),
137 | stream_type=StreamType().pulse_stream,
138 | )
139 | add_to_queue(chat_id, songname, ytlink, url, "Audio", 0)
140 | await huehue.edit(f"**Started Playing Audio ▶** \n**🎧 SONG** : [{songname}]({url}) \n**💬 CHAT** : `{chat_id}`", disable_web_page_preview=True)
141 | except Exception as ep:
142 | await huehue.edit(f"`{ep}`")
143 |
144 | @Client.on_message(filters.command(['stream'], prefixes=f"{HNDLR}"))
145 | async def stream(client, m: Message):
146 | chat_id = m.chat.id
147 | if len(m.command) < 2:
148 | await m.reply("`Give A Link/LiveLink/.m3u8 URL/YTLink to Play Audio from 🎶`")
149 | else:
150 | link = m.text.split(None, 1)[1]
151 | huehue = await m.reply("`Trying to Play 📻`")
152 |
153 | # Filtering out YouTube URL's
154 | regex = r"^(https?\:\/\/)?(www\.youtube\.com|youtu\.?be)\/.+"
155 | match = re.match(regex,link)
156 | if match:
157 | hm, livelink = await ytdl(link)
158 | else:
159 | livelink = link
160 | hm = 1
161 |
162 | if hm==0:
163 | await huehue.edit(f"**YTDL ERROR ⚠️** \n\n`{ytlink}`")
164 | else:
165 | if chat_id in QUEUE:
166 | pos = add_to_queue(chat_id, "Radio 📻", livelink, link, "Audio", 0)
167 | await huehue.edit(f"Queued at **#{pos}**")
168 | else:
169 | try:
170 | await call_py.join_group_call(
171 | chat_id,
172 | AudioPiped(
173 | livelink,
174 | ),
175 | stream_type=StreamType().pulse_stream,
176 | )
177 | add_to_queue(chat_id, "Radio 📻", livelink, link, "Audio", 0)
178 | await huehue.edit(f"Started Playing **[Radio 📻]({link})** in `{chat_id}`", disable_web_page_preview=True)
179 | except Exception as ep:
180 | await huehue.edit(f"`{ep}`")
181 |
--------------------------------------------------------------------------------
/VCBot/vplay.py:
--------------------------------------------------------------------------------
1 | import os
2 | import re
3 | import asyncio
4 | from pyrogram import Client
5 | from VCBot.queues import QUEUE, add_to_queue
6 | from config import bot, call_py, HNDLR, contact_filter
7 | from pyrogram import filters
8 | from pyrogram.types import Message
9 | from pytgcalls import StreamType
10 | from pytgcalls.types.input_stream import AudioVideoPiped
11 | from pytgcalls.types.input_stream.quality import HighQualityAudio, MediumQualityAudio
12 | from pytgcalls.types.input_stream.quality import HighQualityVideo, MediumQualityVideo, LowQualityVideo
13 | from youtubesearchpython import VideosSearch
14 |
15 |
16 | def ytsearch(query):
17 | try:
18 | search = VideosSearch(query, limit=1)
19 | for r in search.result()["result"]:
20 | ytid = r['id']
21 | if len(r['title']) > 34:
22 | songname = r['title'][:35] + "..."
23 | else:
24 | songname = r['title']
25 | url = f"https://www.youtube.com/watch?v={ytid}"
26 | return [songname, url]
27 | except Exception as e:
28 | print(e)
29 | return 0
30 |
31 | # YTDL
32 | # https://github.com/pytgcalls/pytgcalls/blob/dev/example/youtube_dl/youtube_dl_example.py
33 | async def ytdl(link):
34 | proc = await asyncio.create_subprocess_exec(
35 | 'youtube-dl',
36 | '-g',
37 | '-f',
38 | # CHANGE THIS BASED ON WHAT YOU WANT
39 | 'best[height<=?720][width<=?1280]',
40 | f'{link}',
41 | stdout=asyncio.subprocess.PIPE,
42 | stderr=asyncio.subprocess.PIPE,
43 | )
44 | stdout, stderr = await proc.communicate()
45 | if stdout:
46 | return 1, stdout.decode().split('\n')[0]
47 | else:
48 | return 0, stderr.decode()
49 |
50 |
51 | @Client.on_message(filters.command(['vplay'], prefixes=f"{HNDLR}"))
52 | async def vplay(client, m: Message):
53 | replied = m.reply_to_message
54 | chat_id = m.chat.id
55 | if replied:
56 | if replied.video or replied.document:
57 | huehue = await replied.reply("`Downloading`")
58 | dl = await replied.download()
59 | link = replied.link
60 | if len(m.command) < 2:
61 | Q = 720
62 | else:
63 | pq = m.text.split(None, 1)[1]
64 | if pq == "720" or "480" or "360":
65 | Q = int(pq)
66 | else:
67 | Q = 720
68 | await huehue.edit("`Only 720, 480, 360 Allowed` \n`Now Streaming in 720p`")
69 |
70 | if replied.video:
71 | songname = replied.video.file_name[:35] + "..."
72 | elif replied.document:
73 | songname = replied.document.file_name[:35] + "..."
74 |
75 | if chat_id in QUEUE:
76 | pos = add_to_queue(chat_id, songname, dl, link, "Video", Q)
77 | await huehue.edit(f"Queued at **#{pos}**")
78 | else:
79 | if Q==720:
80 | hmmm = HighQualityVideo()
81 | elif Q==480:
82 | hmmm = MediumQualityVideo()
83 | elif Q==360:
84 | hmmm = LowQualityVideo()
85 | await call_py.join_group_call(
86 | chat_id,
87 | AudioVideoPiped(
88 | dl,
89 | HighQualityAudio(),
90 | hmmm
91 | ),
92 | stream_type=StreamType().pulse_stream,
93 | )
94 | add_to_queue(chat_id, songname, dl, link, "Video", Q)
95 | await huehue.edit(f"**Started Playing Video ▶** \n**🎧 SONG** : [{songname}]({link}) \n**💬 CHAT** : `{chat_id}`", disable_web_page_preview=True)
96 | else:
97 | if len(m.command) < 2:
98 | await m.reply("`Reply to an Audio File or give something to Search`")
99 | else:
100 | huehue = await m.reply("`Searching...`")
101 | query = m.text.split(None, 1)[1]
102 | search = ytsearch(query)
103 | Q = 720
104 | hmmm = HighQualityVideo()
105 | if search==0:
106 | await huehue.edit("`Found Nothing for the Given Query`")
107 | else:
108 | songname = search[0]
109 | url = search[1]
110 | hm, ytlink = await ytdl(url)
111 | if hm==0:
112 | await huehue.edit(f"**YTDL ERROR ⚠️** \n\n`{ytlink}`")
113 | else:
114 | if chat_id in QUEUE:
115 | pos = add_to_queue(chat_id, songname, ytlink, url, "Video", Q)
116 | await huehue.edit(f"Queued at **#{pos}**")
117 | else:
118 | try:
119 | await call_py.join_group_call(
120 | chat_id,
121 | AudioVideoPiped(
122 | ytlink,
123 | HighQualityAudio(),
124 | hmmm
125 | ),
126 | stream_type=StreamType().pulse_stream,
127 | )
128 | add_to_queue(chat_id, songname, ytlink, url, "Video", Q)
129 | await huehue.edit(f"**Started Playing Video ▶** \n**🎧 SONG** : [{songname}]({url}) \n**💬 CHAT** : `{chat_id}`", disable_web_page_preview=True)
130 | except Exception as ep:
131 | await huehue.edit(f"`{ep}`")
132 |
133 | else:
134 | if len(m.command) < 2:
135 | await m.reply("`Reply to an Audio File or give something to Search`")
136 | else:
137 | huehue = await m.reply("`Searching...`")
138 | query = m.text.split(None, 1)[1]
139 | search = ytsearch(query)
140 | Q = 720
141 | hmmm = HighQualityVideo()
142 | if search==0:
143 | await huehue.edit("`Found Nothing for the Given Query`")
144 | else:
145 | songname = search[0]
146 | url = search[1]
147 | hm, ytlink = await ytdl(url)
148 | if hm==0:
149 | await huehue.edit(f"**YTDL ERROR ⚠️** \n\n`{ytlink}`")
150 | else:
151 | if chat_id in QUEUE:
152 | pos = add_to_queue(chat_id, songname, ytlink, url, "Video", Q)
153 | await huehue.edit(f"Queued at **#{pos}**")
154 | else:
155 | try:
156 | await call_py.join_group_call(
157 | chat_id,
158 | AudioVideoPiped(
159 | ytlink,
160 | HighQualityAudio(),
161 | hmmm
162 | ),
163 | stream_type=StreamType().pulse_stream,
164 | )
165 | add_to_queue(chat_id, songname, ytlink, url, "Video", Q)
166 | await huehue.edit(f"**Started Playing Video ▶** \n**🎧 SONG** : [{songname}]({url}) \n**💬 CHAT** : `{chat_id}`", disable_web_page_preview=True)
167 | except Exception as ep:
168 | await huehue.edit(f"`{ep}`")
169 |
170 |
171 | @Client.on_message(filters.command(['vstream'], prefixes=f"{HNDLR}"))
172 | async def vstream(client, m: Message):
173 | chat_id = m.chat.id
174 | if len(m.command) < 2:
175 | await m.reply("`Give A Link/LiveLink/.m3u8 URL/YTLink to Stream from 🎶`")
176 | else:
177 | if len(m.command)==2:
178 | link = m.text.split(None, 1)[1]
179 | Q = 720
180 | huehue = await m.reply("`Trying to Stream 💭`")
181 | elif len(m.command)==3:
182 | op = m.text.split(None, 1)[1]
183 | link = op.split(None, 1)[0]
184 | quality = op.split(None, 1)[1]
185 | if quality == "720" or "480" or "360":
186 | Q = int(quality)
187 | else:
188 | Q = 720
189 | await m.reply("`Only 720, 480, 360 Allowed` \n`Now Streaming in 720p`")
190 | huehue = await m.reply("`Trying to Stream 💭`")
191 | else:
192 | await m.reply("`!vstream {link} {720/480/360}`")
193 |
194 | # Filtering out YouTube URL's
195 | regex = r"^(https?\:\/\/)?(www\.youtube\.com|youtu\.?be)\/.+"
196 | match = re.match(regex,link)
197 | if match:
198 | hm, livelink = await ytdl(link)
199 | else:
200 | livelink = link
201 | hm = 1
202 |
203 | if hm==0:
204 | await huehue.edit(f"**YTDL ERROR ⚠️** \n\n`{ytlink}`")
205 | else:
206 | if chat_id in QUEUE:
207 | pos = add_to_queue(chat_id, "Live Stream 📺", livelink, link, "Video", Q)
208 | await huehue.edit(f"Queued at **#{pos}**")
209 | else:
210 | if Q==720:
211 | hmmm = HighQualityVideo()
212 | elif Q==480:
213 | hmmm = MediumQualityVideo()
214 | elif Q==360:
215 | hmmm = LowQualityVideo()
216 | try:
217 | await call_py.join_group_call(
218 | chat_id,
219 | AudioVideoPiped(
220 | livelink,
221 | HighQualityAudio(),
222 | hmmm
223 | ),
224 | stream_type=StreamType().pulse_stream,
225 | )
226 | add_to_queue(chat_id, "Live Stream 📺", livelink, link, "Video", Q)
227 | await huehue.edit(f"Started **[Live Stream 📺]({link})** in `{chat_id}`", disable_web_page_preview=True)
228 | except Exception as ep:
229 | await huehue.edit(f"`{ep}`")
230 |
--------------------------------------------------------------------------------
/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 | .
675 |
--------------------------------------------------------------------------------