Proxy support

vt.tiktok.com + tiktok.com/t support in TikTok URL option

.env.example

@@ -2,8 +2,8 @@
 # LATTE_CACHE=/tmp/proxitok_api # Path for Latte cache, leave commented for ./cache/latte
 
 # API CONFIG
-# API_SIGNER_URL="https://example.com" # External signing service
-# API_BROWSER_URL="http://localhost:4444" # chromedriver url
+# API_SIGNER="remote"
+# API_SIGNER_URL="http://localhost:8080"
 # API_TEST_ENDPOINTS=true # Uncomment for usage of testing TikTok endpoints, may help sometimes
 # API_CACHE=redis
 
@@ -14,3 +14,9 @@
 
 # JSON cache, used on Helpers\CacheEngines\JSONCache
 # API_CACHE_JSON=/tmp/proxitok_api # Path for JSON API Cache, leave commented for ./cache/api
+
+# Proxy Config
+# PROXY_HOST=http://EXAMPLE_IP # Host to be used as proxy, make sure to type a valid protocol. Available: http:// | https:// | socks4:// | socks5://
+# PROXY_PORT=8080
+# PROXY_USERNAME=username
+# PROXY_PASSWORD=password

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+liberapay: 'pablouser1'
+custom: 'https://paypal.me/pablouser1'

.github/ISSUE_TEMPLATE/add-my-instance.md

@@ -0,0 +1,12 @@
+---
+name: Add my instance
+about: Add public instance to the list
+title: "[INSTANCES] New public instance"
+labels: ''
+assignees: ''
+
+---
+
+- URL: https://proxitok.example.com
+- Cloudflare: Yes / No
+- Country: Type the name of the country you are hosting the instance here

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: pablouser1
+
+---
+
+Before submitting an issue, please make sure you are using the latest version of ProxiTok.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add PHP logs to help explain the issue.
+
+**Enviroment (please complete the following information):**
+
+- Deployment method (if possible): [e.g docker, heroku, manual...]
+- Frontend version: [e.g. 2.2.0.0]
+- Scrapper version: [e.g. 2.4.0.0]
+- PHP Version: [e.g. 8.0]
+
+You can find the frontend and scrapper version on /about

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.

Dockerfile

@@ -1,4 +1,4 @@
-FROM php:8-apache
+FROM php:8.1-apache
 WORKDIR /var/www/html
 COPY --from=composer /usr/bin/composer /usr/bin/composer
 RUN apt update -y && apt upgrade -y \

README.md

@@ -33,10 +33,12 @@ Apply to: Main window (address bar)
 ```
 
 ## TODO / Known issues
+* Replace placeholder favicon
 * Make video on /video fit screen and don't overflow
 * Fix embed styling
 * Fix crash when invalid vm.tiktok.com/CODE or www.tiktok.com/t/CODE is provided
 * Add custom amount of videos per page
+* Discover does not work
 
 ## Credits
 [@TheFrenchGhosty](https://github.com/TheFrenchGhosty): Initial Dockerfile and fixes to a usable state. You can check his Docker image [here](https://github.com/PussTheCat-org/docker-proxitok-quay) on Github or [here](https://quay.io/repository/pussthecatorg/proxitok) on Quay

app/Cache/JSONCache.php

@@ -1,7 +1,9 @@
 <?php
 namespace App\Cache;
 
-class JSONCache {
+use TikScraper\CacheInterface;
+
+class JSONCache implements CacheInterface {
     private string $cache_path = __DIR__ . '/../../cache/api';
 
     function __construct() {
@@ -24,7 +26,7 @@ class JSONCache {
         return is_file($filename);
     }
 
-    public function set(string $cache_key, mixed $data, $timeout = 3600) {
+    public function set(string $cache_key, string $data, $timeout = 3600) {
         file_put_contents($this->cache_path . '/' . $cache_key . '.json', $data);
     }
 }

app/Cache/RedisCache.php

@@ -1,7 +1,9 @@
 <?php
 namespace App\Cache;
 
-class RedisCache {
+use TikScraper\CacheInterface;
+
+class RedisCache implements CacheInterface {
     private \Redis $client;
     function __construct(string $host, int $port, ?string $password) {
         $this->client = new \Redis();
@@ -21,10 +23,7 @@ class RedisCache {
 
     public function get(string $cache_key): ?object {
         $data = $this->client->get($cache_key);
-        if ($data) {
-            return json_decode($data);
-        }
-        return null;
+        return $data ? json_decode($data) : null;
     }
 
     public function exists(string $cache_key): bool {

app/Constants/CacheMethods.php

@@ -0,0 +1,7 @@
+<?php
+namespace App\Constants;
+
+class CacheMethods {
+    const JSON = 'json';
+    const REDIS = 'redis';
+}

app/Controllers/RedirectController.php

@@ -1,5 +1,6 @@
 <?php
 namespace App\Controllers;
+use App\Helpers\ErrorHandler;
 use App\Helpers\Misc;
 
 /**
@@ -11,6 +12,13 @@ class RedirectController {
         if (isset($_GET['type'], $_GET['term'])) {
             $term = trim($_GET['term']);
             switch ($_GET['type']) {
+                case 'url':
+                    $endpoint = self::to_endpoint($term);
+                    if (!$endpoint) {
+                        echo 'Invalid or unknown TikTok URL format';
+                        return;
+                    }
+                    break;
                 case 'user':
                     // Remove @ if sent
                     if ($term[0] === '@') {
@@ -39,4 +47,33 @@ class RedirectController {
         $url = Misc::url($endpoint);
         header("Location: {$url}");
     }
+
+    /**
+     * to_endpoint maps a TikTok URL into a ProxiTok-compatible endpoint URL.
+     */
+    static private function to_endpoint(string $url): string {
+        if (preg_match('%^(?:https?://|www\.)?(?:vm\.|vt\.)?tiktok\.com/(?:t/)?([A-Za-z0-9]+)%', $url, $m)) {
+            // Short video URL
+            return '/@placeholder/video/' . $m[1];
+        } elseif (preg_match('%^https://www\.tiktok\.com/(.+)%', $url, $m)) {
+            // Username component (which may indicate a user profile URL or a video URL)
+            if (preg_match('%^(@[A-Za-z0-9_.]+)(?:/|$)(.*)%', $m[1], $u)) {
+                if ($u[2] == '') {
+                    // User profile URL
+                    return '/' . $u[1];
+                } elseif (preg_match('%^video/(\d+)%', $u[2], $v)) {
+                    // Video URL
+                    return '/' . $u[1] . '/video/' . $v[1];
+                }
+            } elseif (preg_match('%^tag/([^ ]+?)(?:/|$)%', $m[1], $t)) {
+                // Tag URL
+                return '/tag/' . $t[1];
+            } elseif (preg_match('%^music/([^ ]+?)(?:/|$)%', $m[1], $m)) {
+                // Music URL
+                return '/music/' . $m[1];
+            }
+        }
+
+        return '';
+    }
 }

app/Helpers/Wrappers.php

@@ -3,6 +3,7 @@ namespace App\Helpers;
 
 use App\Cache\JSONCache;
 use App\Cache\RedisCache;
+use App\Constants\CacheMethods;
 
 class Wrappers {
     /**
@@ -49,22 +50,49 @@ class Wrappers {
      * Setup of TikTok Api wrapper
      */
     static public function api(): \TikScraper\Api {
+        $method = Misc::env('API_SIGNER', '');
+        $url = Misc::env('API_SIGNER_URL', '');
+        if (!$method) {
+            // Legacy support
+            $browser_url = Misc::env('API_BROWSER_URL', '');
+            if ($url) {
+                $method = 'remote';
+            } elseif ($browser_url) {
+                $url = $browser_url;
+                $method = 'browser';
+            }
+        }
+
         $options = [
             'use_test_endpoints' => Misc::env('API_TEST_ENDPOINTS', false) || isset($_COOKIE['api-test_endpoints']) && $_COOKIE['api-test_endpoints'] === 'yes',
             'signer' => [
-                'remote_url' => Misc::env('API_SIGNER_URL', ''),
-                'browser_url' => Misc::env('API_BROWSER_URL', ''),
+                'method' => $method,
+                'url' => $url,
                 'close_when_done' => false
             ]
         ];
+
+        // -- PROXY CONFIG -- //
+        $proxy_host = Misc::env('PROXY_HOST', '');
+        $proxy_port = Misc::env('PROXY_PORT', '');
+
+        if ($proxy_host && $proxy_port) {
+            $options['proxy'] = [
+                'host' => $proxy_host,
+                'port' => $proxy_port,
+                'username' => Misc::env('PROXY_USERNAME', null),
+                'password' => Misc::env('PROXY_PASSWORD', null)
+            ];
+        }
+
         // Cache config
-        $cacheEngine = false;
+        $cacheEngine = null;
         if (isset($_ENV['API_CACHE'])) {
             switch ($_ENV['API_CACHE']) {
-                case 'json':
+                case CacheMethods::JSON:
                     $cacheEngine = new JSONCache();
                     break;
-                case 'redis':
+                case CacheMethods::REDIS:
                     if (!(isset($_ENV['REDIS_URL']) || isset($_ENV['REDIS_HOST'], $_ENV['REDIS_PORT']))) {
                         throw new \Exception('You need to set REDIS_URL or REDIS_HOST and REDIS_PORT to use Redis Cache!');
                     }

components/head.latte

@@ -2,6 +2,10 @@
 	<meta charset="UTF-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<link rel="apple-touch-icon" sizes="180x180" href="{path('/apple-touch-icon.png')}">
+	<link rel="icon" type="image/png" sizes="32x32" href="{path('/favicon-32x32.png')}">
+	<link rel="icon" type="image/png" sizes="16x16" href="{path('/favicon-16x16.png')}">
+	<link rel="manifest" href="{path('/site.webmanifest')}">
 	<meta property="og:title" content="ProxiTok" />
 	<meta property="og:description" content="Alternative frontend for TikTok" />
 	<meta property="og:type" content="website" />

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "pablouser1/proxitok",
     "description": "An alternative frontend for TikTok",
-    "version": "2.3.2.1",
+    "version": "2.4.1.0",
     "license": "AGPL-3.0-or-later",
     "type": "project",
     "authors": [
@@ -24,7 +24,7 @@
         "latte/latte": "^2.11",
         "bramus/router": "^1.6",
         "josegonzalez/dotenv": "dev-master",
-        "pablouser1/tikscraper": "^2.1"
+        "pablouser1/tikscraper": "^2.2"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "15ff00ea59afbf0d6d064d4cbefb05fb",
+    "content-hash": "a7e4990ac4c1935a8cdc93939bf26dc9",
     "packages": [
         {
             "name": "bramus/router",
@@ -263,16 +263,16 @@
         },
         {
             "name": "pablouser1/tikscraper",
-            "version": "v2.1.1.0",
+            "version": "v2.2.1.1",
             "source": {
                 "type": "git",
                 "url": "https://github.com/pablouser1/TikScraperPHP.git",
-                "reference": "4aa97bbcb54f1d1677830acd2fae5b6c8f22c699"
+                "reference": "535ed6db108c9a0ec41b271bea8a6a10700cc5d7"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/pablouser1/TikScraperPHP/zipball/4aa97bbcb54f1d1677830acd2fae5b6c8f22c699",
-                "reference": "4aa97bbcb54f1d1677830acd2fae5b6c8f22c699",
+                "url": "https://api.github.com/repos/pablouser1/TikScraperPHP/zipball/535ed6db108c9a0ec41b271bea8a6a10700cc5d7",
+                "reference": "535ed6db108c9a0ec41b271bea8a6a10700cc5d7",
                 "shasum": ""
             },
             "require": {
@@ -304,9 +304,9 @@
             "description": "Get data from TikTok API",
             "support": {
                 "issues": "https://github.com/pablouser1/TikScraperPHP/issues",
-                "source": "https://github.com/pablouser1/TikScraperPHP/tree/v2.1.1.0"
+                "source": "https://github.com/pablouser1/TikScraperPHP/tree/v2.2.1.1"
             },
-            "time": "2022-07-03T16:07:00+00:00"
+            "time": "2022-09-03T11:19:59+00:00"
         },
         {
             "name": "php-webdriver/webdriver",
@@ -571,16 +571,16 @@
         },
         {
             "name": "symfony/process",
-            "version": "v5.4.8",
+            "version": "v5.4.11",
             "source": {
                 "type": "git",
                 "url": "https://github.com/symfony/process.git",
-                "reference": "597f3fff8e3e91836bb0bd38f5718b56ddbde2f3"
+                "reference": "6e75fe6874cbc7e4773d049616ab450eff537bf1"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/symfony/process/zipball/597f3fff8e3e91836bb0bd38f5718b56ddbde2f3",
-                "reference": "597f3fff8e3e91836bb0bd38f5718b56ddbde2f3",
+                "url": "https://api.github.com/repos/symfony/process/zipball/6e75fe6874cbc7e4773d049616ab450eff537bf1",
+                "reference": "6e75fe6874cbc7e4773d049616ab450eff537bf1",
                 "shasum": ""
             },
             "require": {
@@ -613,7 +613,7 @@
             "description": "Executes commands in sub-processes",
             "homepage": "https://symfony.com",
             "support": {
-                "source": "https://github.com/symfony/process/tree/v5.4.8"
+                "source": "https://github.com/symfony/process/tree/v5.4.11"
             },
             "funding": [
                 {
@@ -629,7 +629,7 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2022-04-08T05:07:18+00:00"
+            "time": "2022-06-27T16:58:25+00:00"
         }
     ],
     "packages-dev": [],

docker-compose.yml

@@ -11,6 +11,7 @@ services:
       - API_CACHE=redis
       - REDIS_HOST=proxitok-redis
       - REDIS_PORT=6379
+      - API_SIGNER=remote
       - API_SIGNER_URL=http://proxitok-signer:8080/signature
     volumes:
       - proxitok-cache:/cache

site.webmanifest

@@ -0,0 +1,23 @@
+{
+  "name": "ProxiTok",
+  "short_name": "ProxiTok",
+  "description": "Use TikTok with a privacy-friendly alternative frontend",
+  "orientation": "portrait-primary",
+  "icons": [
+    {
+      "src": "./android-chrome-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
+    {
+      "src": "./android-chrome-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png"
+    }
+  ],
+  "id": "./",
+  "start_url": "./",
+  "theme_color": "#4040ff",
+  "background_color": "#ffffff",
+  "display": "standalone"
+}

views/error.latte

@@ -3,10 +3,8 @@
 {block content}
 	<p class="title">There was an error processing your request!</p>
 	<p class="subtitle">HTTP Code: {$error->http_code}</p>
-	{if $error->tiktok_code}
-		<p class="subtitle">API error code {$error->tiktok_code} ({$error->tiktok_msg})</p>
-		{if $error->tiktok_code === 10000}
-			<a href="{path('/verify')}">What does this mean?</a>
-		{/if}
+	<p class="subtitle">API error code {$error->tiktok_code} ({$error->tiktok_msg})</p>
+	{if $error->tiktok_code === 10000 || $error->tiktok_code === -1}
+		<a href="{path('/verify')}">What does this mean?</a>
 	{/if}
 {/block}

views/home.latte

@@ -12,6 +12,7 @@
 				<div class="control">
 					<div class="select">
 						<select name="type">
+							<option value="url">TikTok URL</option>
 							<option value="user">Username</option>
 							<option value="tag">Tag</option>
 							<option value="music">Music ID</option>

views/rss.latte

@@ -1,6 +1,6 @@
 {contentType application/rss+xml}
 {do header('Content-Disposition: attachment; filename="' . $title . '.rss' . '"')}
-{do $full_link = path($link)}
+{var $full_link = path($link)}
 <?xml version="1.0" encoding="utf-8" ?>
 <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
 	<channel>

views/verify.latte

@@ -7,7 +7,7 @@
 
 {block content}
 	<p>TL;DR You probably have to search for another instance or wait some hours (or even better, have your own self-hosted instance)</p>
-	<p>TikTok has some mecanisms in order to stop scraping on their latest api (/api/...):</p>
+	<p>TikTok has some mecanisms in order to stop scraping on their api:</p>
 	<hr />
 	<div class="block">
 		<p class="is-size-4">Rate limits</p>