adguardteam/adguardforios

The most advanced ad blocker for iOS

 

The most advanced Safari content blocker and privacy keeper for iOS

Top-notch ad blocking in Safari, anti-tracking protection and DNS privacy.

Website | Reddit | Twitter | Telegram

• Contribution
  • How to report an issue
  • Translating AdGuard
  • Other options
  • How to become a Beta tester
• Our plans
• How to build

AdGuard for iOS is an app that blocks ads in Safari browser at exceptional level, and also provides additional Premium features like configurable DNS settings, encrypted DNS support (DOH, DOT, DNSCrypt), and custom ad blocking subscriptions. To get more information and to download AdGuard for iOS, visit our website.

Contribution

How to report an issue?

GitHub can be used to report a bug or to submit a feature request. To do so, go to this page and click the New issue button.

Note: for the filter-related issues (missed ads, false positives etc.) use our reporting tool.

Translating AdGuard

If you want to help with AdGuard translations, please learn more about translating our products here: https://kb.adguard.com/en/general/adguard-translations

Other options

Here is a dedicated page for those who are willing to contribute.

How to become a beta tester?

You can submit an application to participate in AdGuard for beta-testing program. All necessary information on this topic can be found on the dedicated page.

Our plans

To see the 'big picture', to watch current progress and to get an idea of approximate dates for upcoming AdGuard for iOS releases, see this page: https://github.com/AdguardTeam/AdguardForIos/milestones

How to build

(optional) Install a newer ruby version:

brew install ruby

Add to your ~/.bash_profile

export PATH="/usr/local/opt/ruby/bin:$PATH"
export PATH="/usr/local/lib/ruby/gems/2.7.0/bin:$PATH"

Prepare

Prepare and install Ruby bundler:

• sudo gem install bundler

Configure bundler to use local directory for storing dependencies:

• bundle config set --local path '.bundle/vendor'

Then run bundle install:

• bundle install

IMPORTANT: before running Fastlane, you need to place the App Store Connect API key to fastlane/AuthKey.p8.

Then you can run Fastlane using a command like this:

• bundle exec fastlane [lane]

Register your device:

• bundle exec fastlane run register_device udid:"UUID" name:"Device name"

Codesigning

Run this command to get proper codesigning certificates:

• bundle exec fastlane prepare

Actions

• bundle exec fastlane tests -- run tests
• bundle exec fastlane build -- build version for App Store

Actions below are supposed to be used from CI only:

• bundle exec fastlane adhoc -- build adhoc version (for inner testing)
• bundle exec fastlane increment -- increments build number, commits it to git
• bundle exec fastlane testflight_beta -- upload previously built version to testflight

In the case when certificate expires, you may need to nuke the old certs and generate them again:

bundle exec fastlane match nuke development
bundle exec fastlane match nuke distribution
bundle exec fastlane generate

In order for fastlane to work properly in CI environment, we use spaceauth.

Run this command to generate FASTLANE_SESSION which you'll then need to use on the CI server:

bundle exec fastlane auth

Acknowledgments

Please visit the acknowledgements page

adguardforios's Issues

Extend an article about creating own filter rules with information about Safari restrictions

http://adguard.com/en/filterrules.html

Don't forget about AG for Android restrictions.
Like no support of [parent-elements] modifier and such.

Add information about wildcard modifier also.

Ignore language selected in 'Advanced' settings of iPhone when choosing in-app language

Otherwise parts of Adguard interface are displayed in that language, no matter what is chosen as default language for the device (for example, filters in filter list).

There are some complaints on filters speed

Users are complaining on v1.0.1.
Maybe the problem is in the url-filter trigger, we've replaced .* with ^http://*

We lost string resources from shared library, which must be localized.

Twitter message is too long

Replace it with something short like "Adguard - Adblock for iOS:"

Loading filter screen hangs

Ticket ID: VKR-640-41432

adguard_ios.txt

Update the README.md

Improve regular expression used for URL matching

Add Acknowledgments link to "About" section

Create a Safari Action Extension to whitelist (or remove from whitelist) the website

Add Spanish, Italian and Serbian translations

Fill readme with information on how to build the project

List of user rules or whitelist is not updated in background, when state of the site filtration is changed from Safari Adguard action extension.

Add Adguard version to the log

A rule from German filter is converted with error

The rule itself:

@@/^https?\:\/\/(?!(qs\.ivwbox\.de|qs\.ioam.de|platform\.twitter\.com|connect\.facebook\.net|de\.ioam\.de|pubads\.g\.doubleclick\.net|stats\.wordpress\.com|www\.google-analytics\.com|www\.googletagservices\.com|apis\.google\.com|script\.ioam\.de)\/)/$script,third-party,domain=gamona.de

For some reason this rule is converted with | mark which is not supported by Safari regular expressions subset.

Here is the conversion result:

[
    {
        "trigger": {
            "url-filter": "^https?\\:\\/\\/(?!(qs\\.ivwbox\\.de|qs\\.ioam.de|platform\\.twitter\\.com|connect\\.facebook\\.net|de\\.ioam\\.de|pubads\\.g\\.doubleclick\\.net|stats\\.wordpress\\.com|www\\.google-analytics\\.com|www\\.googletagservices\\.com|apis\\.google\\.com|script\\.ioam\\.de)\\/)",
            "resource-type": [
                "script"
            ],
            "load-type": [
                "third-party"
            ],
            "if-domain": [
                "*gamona.de"
            ]
        },
        "action": {
            "type": "ignore-previous-rules"
        }
    }
]

Add tutorial page about Adguard Action Extension for Safari

There should be a way to report missed ads or incorrectly blocked content from Safari extension

Add to buttons to Safari extension popup:

1. Report Missed Ad >
2. Report Incorrect Blocking >

Tapping on any of these buttons opens mail app (just like we do for "Send Bug Report").

The difference is the email subject and content.

"Subject" is equal to the button text. Something like [Adguard for iOS] Report Missed Ad
Mail content contains link to the webpage.

Implement "Edit" mode in the filters list

From #11

One more thing: Turning it on and off quickly wouldn't work that way nevertheless, since the app (or the OS) needs too much time to load the changed set of filters. It would not be possible to work through the filters list as fast as you read the filter names and swipe them to toggle just how you need them.

So - with that in mind, it might be nice to have an edit mode. Like: have an "edit"-Button in the upper right (making that feature obvious), tap it, have all the > signs replaced with a toggle, work fast through the filter list toggling them as needed, tap "done", and wait until the new filter set is loaded.

That way, you can first concentrate on customizing the filter list without constantly being interrupted by the app loading filters, and give the app time to load the filters when you are done.

Implement "optimize" option in the converter

This option will be used in iOS only.

If it is set to true - ignore all generic element hiding rules. Leave site-specific only.

Learn possibilities of the search technology in apps on iOS 9

https://developer.apple.com/library/prerelease/ios/documentation/General/Conceptual/AppSearch/

Add Polish translation

Banners are not blocked on mobile01.com

Must be blocked by /mod_ad/* rule.
Works on desktop Safari, but for some reason it does not work on iOS.

Examples:
http://attach2.mobile01.com/image/mod_ad/mobile01-36b57f5bf0bfb3229ecd579a41ad4f83.htm?ad_url=http%3A%2F%2Fwww.mobile01.com%2Fadredir.php%3Fid%3D59043&clickTAG=http%3A%2F%2Fwww.mobile01.com%2Fadredir.php%3Fid%3D59043
http://attach2.mobile01.com/image/mod_ad/mobile[phone]aaeb3d2d85d2d68fee85e7a650.jpg

Add filter subscription by URL

Add option to subscribe for a filter by URL.
Requester here DHH-171-66322

When I disable and then enable content blocker - it won't apply until I open the app

More than this. If user does not wait for 15-20 seconds inside the app - content blocker won't be applied at all.

We could probably show some "progress loader" on the first app start (until content blocker is loaded normally)?

Add a video explanation on how to use Adguard's action extension

Watch how to manage Adguard from Safari

Edit privacy policy according to #34

Now, when user sends bug report to support, app collects current state data, for example:

Application version: 1.0.3.23.DEBUG
Application lifetime: 2015-10-23 10:26:37 +0000

Device: iPad
Platform: iPhone OS
OS: 9.1
ID: 47082D0B-DA29-4CD0-BE51-2FF94A7B0DCC

Locale: en
Region: us

Filters subscriptions:
ID=0 Name="User filter" Version=1.0.0.0 Enabled=YES
ID=2 Name="English filter" Version=1.0.71 Enabled=YES
ID=3 Name="Spyware filter" Version=1.0.3.75 Enabled=YES
ID=4 Name="Social media filter" Version=1.0.7.28 Enabled=YES
ID=5 Name="Experimental filter" Version=1.0.23.14 Enabled=NO
ID=10 Name="Filter for useful ads" Version=1.0.0.78 Enabled=NO
ID=1 Name="Russian filter" Version=1.0.28.9 Enabled=NO
ID=6 Name="German filter" Version=1.0.21.53 Enabled=NO
ID=7 Name="Japanese filter" Version=1.0.92.87 Enabled=NO
ID=9 Name="Spanish/Portuguese filter" Version=1.0.86.8 Enabled=NO
ID=12 Name="Mobile Safari filter" Version=1.0.0.5 Enabled=NO

ID: 47082D0B-DA29-4CD0-BE51-2FF94A7B0DCC - this is identifierForVendor: "An alphanumeric string that uniquely identifies a device to the app’s vendor.", which is sent, also, when filter update request is performed.

Intercept abp:subscribe and subscribe.adblockplus.org URLs

https://issues.adblockplus.org/ticket/2208

Look at these filters:
https://adblockplus.org/subscriptions

You should first compare the subscription URL you've got with the subscription URLs of the filters you have. If it matches any you should enable this filter in AG.

If no match found we should offer user to import the rules to his "User Filter"

Create "Adguard for iOS" section on "Acknowledgments" page

Third-party components:
StaticDataTableViewController - https://github.com/peterpaulis/StaticDataTableViewController
GZIP - https://github.com/nicklockwood/GZIP

Ask @Stillness-2 for more info.

Implement Adguard Assistant feature (Block element on the page)

Here is how Firebug mobile works:
https://getfirebug.com/firebuglite_mobile

What do I suggest:

1. User selects Adguard's activity
2. There should be an additional option: "Block element on this page"
3. Tapping on that option brings back the webpage with new javascript injected there
4. This javascript works like firebug allowing user to select an element

@Stillness-2 seems legit?

"Loading filters" panel is broken in iOS 9.1

Cannot add link to the whitelist

Steps to reproduce

1. Open any website in Safari
2. Copy URL
3. Go to Adguard's Whitelist
4. Tap "+" icon
5. Try to paste the URL

Expected result:
URL is pasted

Result:
None

We should transform URL to domain name

Whitelist and user filter rules are applied with a huge delay

Deleting whitelist rule does not trigger conversion.

German: No text when user clicks "Share" on facebook

Error loading filters version info: The request timed out.

Occasionally see this line in the log.

Really often in this log:
QYQ-791-81046

Add "Use simplified filters" setting

#44
If this option is enabled, pass "optimize" option to the rules converter.

We also need a help text somewhere describing what that setting means.

The last screen of the quick tour should have a "Got it" button

• UI: It would be nice to have a "Got it!"-Button or anything like that on the last page of the quick tour. Somehow it feels strange to "go back" to begin the configuration after the tour, it would be more natural to proceed.

We should add a warning somewhere that Safari needs 10-60 seconds to apply Content Blocker

Redesign filters list - it is not obvious how to get to filter details now

Report from a beta tester:

• UI: Actually, I needed to watch the Quick Tour twice to find out that I can tap on a filter to get Details to it. I think there should be a visual hint for that. At first, a chevron on the right end of each filter came to my mind, but I can't remember if I've ever seen a combination of an on/off-toggle with a chevron. Then the blue (i) came to my mind (like at the wifi settings), but actually I don't like the look of that symbol. May be a simple text below the search bar: "tap on a filter to get more information"?

Redesign of the background filters update

May be we need to check version number of the filters synchronously, but download of the filter rules to do asynchronously, in system background download task (NSURLSession).

Change layout - move last checked date under the "Check filters updates" button

Look at iCloud settings, how icloud account name is printed under "iCloud".

Add german translation

no work Ipad 9.1.3

no work Ipad 9.1.3
It is not possible to download
Your application is incompatible with your device

Add $cookie modifier support

That's simple, if $cookie modifier is present, we do not block the request, just suppressing "Cookie" and "Set-Cookie".

Is it possible to check if Adguard is enabled using SafariViewController?

For instance we may open a test webpage there and check if ads are blocked

Redesign of the subscription process so that it became more resistant to errors

Rework user filter editor (use textarea)

Add version parameter to HTTP request downloading filter list

Update "looking for beta testers" thread

http://forum.adguard.com/showthread.php?7172-Looking-for-iOS-beta-testers

Extend Adguard's privacy policy with information about "Adguard for iOS"

Make our app iPad-friendly - implement two-columns layout