Pull request #6: Command line wrapper

Merge in ADGUARD-IOS/safari-converter from feature/commandline to master

* commit '540e7e378f273e58aa619a739ba15cba58744aad':
  updated readme
  updated readme
  github action
  github action
  command line wrapper stdin
  command line wrapper
  wrapped logger
  command line wrapper
  command line wrapper
  command line wrapper
  command line wrapper

Author: Mizzick

.github/workflows/deploy.yml

@@ -0,0 +1,47 @@
+name: Deploy
+
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+jobs:
+  build:
+    runs-on: macOS-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Build
+        run: swift build -v
+
+      - name: Test
+        run: swift test -v
+
+      - name: Build Release Binary
+        run: swift build -v -c release
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body: |
+            - Updated converter binary
+          draft: false
+          prerelease: false
+
+      - name: Upload Release Asset
+        id: upload-release-asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./.build/release/ConverterTool
+          asset_name: ConverterTool
+          asset_content_type: application/macbinary
+

Package.swift

@@ -11,6 +11,9 @@ let package = Package(
             name: "ContentBlockerConverter",
             type: .static,
             targets: ["ContentBlockerConverter"]),
+        .executable(
+            name: "ConverterTool",
+            targets: ["CommandLineWrapper"])
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
@@ -19,6 +22,9 @@ let package = Package(
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages which this package depends on.
+        .target(
+            name: "CommandLineWrapper",
+            dependencies: ["ContentBlockerConverter"]),
         .target(
             name: "ContentBlockerConverter",
             dependencies: []),

README.md

@@ -8,6 +8,18 @@ Content Blocker converter swift code
 Converts filter rules in AdGuard format to the format supported by Safari.
 * https://webkit.org/blog/3476/content-blockers-first-look/
 
+### How to build:
+
+```
+    swift build
+```
+
+### Tests:
+
+```
+    swift test
+```
+
 ### How to use converter:
 
 ```
@@ -24,6 +36,21 @@ The result contains following properties:
 - converted: json string of content blocker rules
 - advancedBlocking: json string of advanced blocking rules
 
+### How to use converter from command line:
+
+```
+    ./ConverterTool -limit=0 -optimize=true -advancedBlocking=false <<STDIN -o other --options
+    test_rule_one
+    test_rule_two
+    STDIN
+```
+
+The tool then reads stdin line by line for rule until an empty line.
+
+### How to release on Github
+
+Push a new tag in `v*.*.*` format, then provided github action is intended to build and publish new release with an asset binary.
+
 ### Supported AdGuard rules types:
 
 #### Basic content blocker format:

Sources/CommandLineWrapper/main.swift

@@ -0,0 +1,84 @@
+import Foundation
+import ContentBlockerConverter
+
+/**
+ * Command line wrapper
+ * Usage:
+ * ./CommandLineWrapper -limit=0 -optimize=true -advancedBlocking=false
+ */
+
+func writeToStdError(str: String) {
+    let handle = FileHandle.standardError;
+    
+    if let data = str.data(using: String.Encoding.utf8, allowLossyConversion: false) {
+        handle.write(data)
+    }
+}
+
+func writeToStdOut(str: String) {
+    let handle = FileHandle.standardOutput;
+    
+    if let data = str.data(using: String.Encoding.utf8, allowLossyConversion: false) {
+        handle.write(data)
+    }
+}
+
+func encodeJson(_ result: ConversionResult) throws -> String {
+    let encoder = JSONEncoder();
+    encoder.outputFormatting = .prettyPrinted
+    
+    let json = try encoder.encode(result);
+    return String(data: json, encoding: .utf8)!.replacingOccurrences(of: "\\/", with: "/");
+}
+
+do {
+    Logger.log("AG: Conversion started");
+    
+    let arguments: [String] = CommandLine.arguments;
+    if (arguments.count < 4) {
+        writeToStdError(str: "AG: Invalid arguments: Usage: ./CommandLineWrapper -limit=0 -optimize=false -advancedBlocking)");
+        exit(EXIT_FAILURE);
+    }
+    
+    let limit = Int(arguments[1][String.Index(encodedOffset: 7)...]) ?? 0;
+    Logger.log("AG: Limit: \(limit)");
+    
+    let optimize = arguments[2] == "-optimize=true";
+    Logger.log("AG: Optimize: \(optimize)");
+    
+    let advancedBlocking = arguments[3] == "-advancedBlocking=true";
+    Logger.log("AG: AdvancedBlocking: \(advancedBlocking)");
+    
+    var rules = [String]();
+    var line: String? = nil;
+    while (true) {
+        line = readLine(strippingNewline: true);
+        if (line == nil || line == "") {
+            break;
+        }
+        
+        rules.append(line!);
+    }
+    
+    Logger.log("AG: Rules to convert: \(rules.count)");
+    
+    let result: ConversionResult? = ContentBlockerConverter().convertArray(
+        rules: rules, limit: limit, optimize: optimize, advancedBlocking: advancedBlocking
+    );
+
+    Logger.log("AG: Conversion done");
+    
+    if (result == nil) {
+        writeToStdError(str: "AG: ContentBlockerConverter: Empty result.");
+        exit(EXIT_FAILURE);
+    }
+    
+    let encoded = try encodeJson(result!);
+    
+    writeToStdOut(str: "\(encoded)");
+    exit(EXIT_SUCCESS);
+} catch {
+    writeToStdError(str: "AG: ContentBlockerConverter: Unexpected error: \(error)");
+    exit(EXIT_FAILURE);
+}
+

Sources/ContentBlockerConverter/Compiler/BlockerEntryFactory.swift

@@ -72,7 +72,7 @@ class BlockerEntryFactory {
             }
         } catch {
             self.errorsCounter.add();
-            NSLog("AG: ContentBlockerConverter: Unexpected error: \(error) while converting \(rule.ruleText)");
+            Logger.log("AG: ContentBlockerConverter: Unexpected error: \(error) while converting \(rule.ruleText)");
         }
 
         return nil;

Sources/ContentBlockerConverter/ContentBlockerConverter.swift

@@ -14,7 +14,7 @@ public class ContentBlockerConverter {
      */
     public func convertArray(rules: [String], limit: Int = 0, optimize: Bool = false, advancedBlocking: Bool = false) -> ConversionResult? {
         if rules.count == 0 {
-            NSLog("AG: ContentBlockerConverter: No rules presented");
+            Logger.log("AG: ContentBlockerConverter: No rules presented");
             return nil;
         }
 
@@ -34,7 +34,7 @@ public class ContentBlockerConverter {
 
             return try Distributor(limit: limit, advancedBlocking: advancedBlocking).createConversionResult(data: compilationResult);
         } catch {
-            NSLog("AG: ContentBlockerConverter: Unexpected error: \(error)");
+            Logger.log("AG: ContentBlockerConverter: Unexpected error: \(error)");
         }
 
         return nil;
@@ -59,6 +59,6 @@ public class ContentBlockerConverter {
         message += "\nExceptions (jsinject): \(String(describing: compilationResult.scriptJsInjectExceptions.count))";
         message += "\nExceptions (other): \(String(describing: compilationResult.other.count))";
 
-        NSLog("AG: ContentBlockerConverter: " + message);
+        Logger.log("AG: ContentBlockerConverter: " + message);
     }
 }

Sources/ContentBlockerConverter/ConversionResult.swift

@@ -3,7 +3,7 @@ import Foundation
 /**
  * Conversion result wrapper class
  */
-public struct ConversionResult {
+public struct ConversionResult: Encodable {
     /**
      * Total entries count in result
      */
@@ -49,7 +49,7 @@ public struct ConversionResult {
         if self.overLimit {
             limitedEntries = Array(entries.prefix(limit));
 
-            NSLog("AG: ContentBlockerConverter: The limit is reached. Overlimit rules will be ignored.");
+            Logger.log("AG: ContentBlockerConverter: The limit is reached. Overlimit rules will be ignored.");
         }
 
         self.convertedCount = limitedEntries.count;

Sources/ContentBlockerConverter/Rules/RuleFactory.swift

@@ -83,7 +83,7 @@ class RuleFactory {
 
             return try NetworkRule(ruleText: ruleText!);
         } catch {
-            NSLog("AG: ContentBlockerConverter: Unexpected error: \(error) while creating rule from: \(String(describing: ruleText))");
+            Logger.log("AG: ContentBlockerConverter: Unexpected error: \(error) while creating rule from: \(String(describing: ruleText))");
             throw error;
         }
     };

Sources/ContentBlockerConverter/Utils/Logger.swift

@@ -0,0 +1,10 @@
+/**
+ * Logger
+ */
+public class Logger {
+    public static func log(_ message: String) {
+      #if DEBUG
+        print("AG: \(message)")
+      #endif
+    }
+}