Feature: add mode script

README.md

@@ -35,30 +35,37 @@
 ## Getting Started
 Documentations are now moved to [GitHub Wiki](https://github.com/Dreamacro/clash/wiki).
 
-## Advanced usage for this fork branch
+## Advanced usage for this branch
 ### TUN configuration
 Supports macOS, Linux and Windows.
 
-Support lwIP stack, a lightweight TCP/IP stack, recommend set to tun.
+Support lwIP stack, a lightweight TCP/IP stack, it's recommended set to tun.
 
 On Windows, you should download the [Wintun](https://www.wintun.net) driver and copy `wintun.dll` into Clash home directory.
 ```yaml
 # Enable the TUN listener
 tun:
   enable: true
-  stack: lwip # lwip(recommend), system or gvisor
+  stack: lwip # lwip(recommended), system or gvisor
   dns-listen: 0.0.0.0:53 # additional dns server listen on TUN
   auto-route: true # auto set global route
 ```
 ### Rules configuration
 - Support rule `GEOSITE`.
+- Support rule `SCRIPT`.
 - Support `multiport` condition for rule `SRC-PORT` and `DST-PORT`.
-- Support not match condition for rule `GEOIP`.
 - Support `network` condition for all rules.
 - Support source IPCIDR condition for all rules, just append to the end.
 
-The `GEOSITE` and `GEOIP` databases via https://github.com/Loyalsoldier/v2ray-rules-dat.
+The `GEOSITE` databases via https://github.com/Loyalsoldier/v2ray-rules-dat.
 ```yaml
+mode: rule
+
+script:
+  shortcuts:
+    quic: 'network == "udp" and dst_port == 443'
+    privacy: '"analytics" in host or "adservice" in host or "firebase" in host or "safebrowsing" in host or "doubleclick" in host'
+
 rules:
   # network condition for all rules
   - DOMAIN-SUFFIX,bilibili.com,DIRECT,tcp
@@ -67,6 +74,10 @@ rules:
   # multiport condition for rules SRC-PORT and DST-PORT
   - DST-PORT,123/136/137-139,DIRECT,udp
   
+  # rule SCRIPT
+  - SCRIPT,quic,REJECT # Disable QUIC, same as rule "- DST-PORT,443,REJECT,udp"
+  - SCRIPT,privacy,REJECT
+  
   # rule GEOSITE
   - GEOSITE,category-ads-all,REJECT
   - GEOSITE,icloud@cn,DIRECT
@@ -76,23 +87,92 @@ rules:
   - GEOSITE,facebook,PROXY
   - GEOSITE,youtube,PROXY
   - GEOSITE,geolocation-cn,DIRECT
-  - GEOSITE,gfw,PROXY
-  - GEOSITE,greatfire,PROXY
-  #- GEOSITE,geolocation-!cn,PROXY
+  - GEOSITE,geolocation-!cn,PROXY
+    
+  # source IPCIDR condition for all rules in gateway proxy
+  #- GEOSITE,apple,PROXY,192.168.1.88/32,192.168.1.99/32
 
   - GEOIP,telegram,PROXY,no-resolve
   - GEOIP,private,DIRECT,no-resolve
   - GEOIP,cn,DIRECT
-    
-  # Not match condition for rule GEOIP
-  #- GEOIP,!cn,PROXY
-    
-  # source IPCIDR condition for all rules in gateway proxy
-  #- GEOIP,!cn,PROXY,192.168.1.88/32,192.168.1.99/32
-
+  
   - MATCH,PROXY
 ```
 
+### Script configuration
+Script enables users to programmatically select a policy for the packets with more flexibility.
+
+```yaml
+mode: script
+
+rules:
+  # the rule GEOSITE just as a rule provider in script mode
+  - GEOSITE,category-ads-all,Whatever
+  - GEOSITE,youtube,Whatever
+  - GEOSITE,geolocation-cn,Whatever
+  
+script:
+  code: |
+    def main(ctx, metadata):
+      if metadata["process_name"] == 'apsd':
+        return "DIRECT"
+
+      if metadata["network"] == 'udp' and metadata["dst_port"] == 443:
+        return "REJECT"
+    
+      host = metadata["host"]
+      for kw in ['analytics', 'adservice', 'firebase', 'bugly', 'safebrowsing', 'doubleclick']:
+        if kw in host:
+          return "REJECT"
+    
+      now = time.now()
+      if (now.hour < 8 or now.hour > 17) and metadata["src_ip"] == '192.168.1.99':
+        return "REJECT"
+      
+      if ctx.rule_providers["geosite:category-ads-all"].match(metadata):
+        return "REJECT"
+    
+      if ctx.rule_providers["geosite:youtube"].match(metadata):
+        ctx.log('[Script] domain %s matched youtube' % host)
+        return "Proxy"
+
+      if ctx.rule_providers["geosite:geolocation-cn"].match(metadata):
+        ctx.log('[Script] domain %s matched geolocation-cn' % host)
+        return "CN"
+    
+      ip = metadata["dst_ip"] 
+      if host != "":
+        ip = ctx.resolve_ip(host)
+        if ip == "":
+          return "Proxy"
+
+      code = ctx.geoip(ip)
+      if code == "LAN" or code == "CN":
+        return "DIRECT"
+
+      return "Proxy" # default policy for requests which are not matched by any other script
+```
+the context and metadata
+```python
+interface Metadata {
+type: string // socks5、http
+network: string // tcp
+host: string
+process_name: string
+src_ip: string
+src_port: int
+dst_ip: string
+dst_port: int
+}
+
+interface Context {
+resolve_ip: (host: string) => string // ip string
+geoip: (ip: string) => string // country code
+log: (log: string) => void
+rule_providers: Record<string, { match: (metadata: Metadata) => boolean }>
+}
+```
+
 ### Proxies configuration
 Support outbound transport protocol `VLESS`.
 
@@ -170,9 +250,6 @@ Add field `Process` to `Metadata` and prepare to get process name for Restful AP
 
 To display process name in GUI please use https://yaling888.github.io/yacd/.
 
-## Premium Release
-[Release](https://github.com/Dreamacro/clash/releases/tag/premium)
-
 ## Development
 If you want to build an application that uses clash as a library, check out the the [GitHub Wiki](https://github.com/Dreamacro/clash/wiki/use-clash-as-a-library)