Added new resource file system #397

PabloOQ · 2024-11-15T13:41:09Z

So, I was going to do a Privacy redirector module as per #7. But I noticed all the logic to download files is in ClearUrlCatalog.java, to avoid code duplication I got sidetracked working on this.
This is the, 4th(? or 3rd, I don't remember) iteration, but the code is still untested, I don't want to spend more time than necessary in something that might not be merged, althought it should work as it is mainly refactoring.

Here is the class diagram to make things clearer at a glance. I have omitted certain things so it is easier to follow
The main thing to worry is the diagonal of abstract classes as each relies on the previous.

classDiagram
    class ResourceContextInterface{
        <<interface>>
        +getContext() Activity
    }

    class ResourceGuideInterface~T~{
        <<interface>>
        +toObject(String content) T
        +toObjectThrows(String content) T
        +toString(T) String
        +getEmpty() T
    }
    ResourceGuideInterface~T~ <|-- ResourceGuide~T~
    ResourceGuideInterface~T~ <|-- BuiltInResource~T~ : Delegates to previous
    ResourceGuideInterface~T~ <|-- ModifiableResource~T~ : Delegates to previous
   
    class ResourceGuide~T~{
        <<abstract>>
        +toObject(String content) T
        +toObjectThrows(String content) T*
        +toString(T) String*
        +getEmpty() T*
    }

    ResourceGuide~JSONObject~ <|-- JsonGuide : JSONObject
    class JsonGuide{
        + toObjectThrows(String content) JSONObject
        + toString(JSONObject content) String
        + getEmpty() JSONObject
    }

    ResourceGuide~T~ o-- BuiltInResource~T~ 
    class BuiltInResource~T~{
        <<abstract>>
        + getBuiltIn() T
        # buildBuiltIn() T*
    }

    BuiltInResource~T~ <|-- BuiltInResourceFile~T~ 
    class BuiltInResourceFile~T~{
        # buildBuiltIn() T
    }

    BuiltInResource~T~ o-- ModifiableResource~T~
    class ModifiableResource~T~{
        <<abstract>>
        + getCatalog() T
        + clear ()
    }

    ModifiableResource~T~ <|-- ManualEditResource~T~
    class ManualEditResource~T~{
        + save()
    }

    ModifiableResource~T~ <|-- UpdateableResource~T~
    class UpdateableResource~T~{
        + _update(boolean background)
    }
    
    UpdateableResource~T~ <|-- AutoUpdateableResource~T~
    class AutoUpdateableResource~T~{
        + updateIfNecessary()
    }

Here is an example to show the actual use.

Create a guide to the extension, used for transforming to string/object (this way we can support other fomats like xml)
Create a builtin source, either a read only file (from the assets folder) or dynamically built, like the patterns checker module
The way this resource will be modified, either manually by the user or it updates from the internet, which can be automatic.

Activity context = null;
// ClearUrls like example
// first, the extension
var type = new JsonGuide();
// second, the builtin source, in this case a file
BuiltInResource<JSONObject> fallback = new BuiltInResourceFile<>(
        context, type, "built-in.json");
// third, how the resource will be modified, in this case it auto downloads
ModifiableResource<JSONObject> modifiable = new AutoUpdateableResource<>(
        fallback, "auto-example.json",
        "example-module",
        "http://fake.domain/catalog",
        "http://fake.domain/hash",
        /*built-in.json-timestamp*/777L/*built-in.json-timestamp*/,
        JavaUtils.weeksToMillis(1));


// Pattern url like example
// first, the extension
type = new JsonGuide();
// second, the builtin source, in this case dynamically built
fallback = new BuiltInResource<>(
        context, type) {
    @Override
    protected JSONObject buildBuiltIn() throws Exception {
        return new JSONObject()

                // built from the translated strings
                .put(context.getString(R.string.mPttrn_ascii), new JSONObject()
                        .put("regex", "[^\\p{ASCII}]")
                )
                .put(context.getString(R.string.mPttrn_http), new JSONObject()
                        .put("regex", "^http://")
                        .put("replacement", "https://")
                )
                ;
    }
};
// third, how the resource will be modified, in this case, manual edit
modifiable = new ManualEditResource<>(
        fallback,"manual-example.json");

If you like this change, let me know and I will keep working on the things that will need to be done in order for this to work:

Change all current implementations of retrieving data from resources, which . Doesn't need to be done all at the same time.
- JsonCatalog hopefully (only requires changing one variable, hopefully)
  - AutomationRules
  - HostCatalogs
  - PatternCatalog
- ClearUrlCatalog
Add an auto migration system (sidetracking again!)
- Only affects the ClearURLs module, as it stores in the same file both, the updateable catalog and the rules made by the user. The new resource system forces both to be different files.

Let me know what you think! And don't worry if you feel like all this should be scrapped, it is a huge change. Take all the time you need I don't want to put any pressure on you, even if that means waiting for other PRs that are currently open.

github-actions · 2024-11-15T13:42:58Z

This PR builds correctly, here is the generated apk.
This unsigned version can be installed alongside the original app and should only be used for testing the changes, not for daily usage.

Download testing apk

You must be logged in for the link to work.
The link will expire in 14 days, at Fri Nov 29 13:42:57 UTC 2024.

_{This is an automatic comment created by a Github Action}

...va/com/trianguloy/urlchecker/modules/companions/ResourceCatalogs/AutoUpdateableResource.java

@@ -0,0 +1,71 @@
+package com.trianguloy.urlchecker.modules.companions.ResourceCatalogs;


...main/java/com/trianguloy/urlchecker/modules/companions/ResourceCatalogs/BuiltInResource.java

@@ -0,0 +1,65 @@
+package com.trianguloy.urlchecker.modules.companions.ResourceCatalogs;


.../java/com/trianguloy/urlchecker/modules/companions/ResourceCatalogs/BuiltInResourceFile.java

@@ -0,0 +1,24 @@
+package com.trianguloy.urlchecker.modules.companions.ResourceCatalogs;


app/src/main/java/com/trianguloy/urlchecker/modules/companions/ResourceCatalogs/JsonGuide.java

@@ -0,0 +1,25 @@
+package com.trianguloy.urlchecker.modules.companions.ResourceCatalogs;


...n/java/com/trianguloy/urlchecker/modules/companions/ResourceCatalogs/ManualEditResource.java

@@ -0,0 +1,23 @@
+package com.trianguloy.urlchecker.modules.companions.ResourceCatalogs;
