adguard-flm 2.6.1

This crate represents a library for managing AdGuard filter lists
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use crate::storage::constants::{
    CUSTOM_FILTERS_GROUP_ID, SERVICE_GROUP_ID, USER_RULES_FILTER_LIST_ID,
};
use crate::storage::entities::filter::filter_entity::FilterEntity;
use crate::storage::entities::filter_group_entity::FilterGroupEntity;
use crate::storage::entities::rules_list::rules_list_entity::RulesListEntity;
use crate::storage::repositories::filter_group_repository::FilterGroupRepository;
use crate::storage::repositories::filter_repository::FilterRepository;
use crate::storage::repositories::rules_list_repository::RulesListRepository;
use crate::storage::repositories::Repository;
use crate::{string, FilterId};
use rusqlite::Transaction;

/// Returns the filter identifier added by default when the base is bootstrapped.
pub(crate) fn get_bootstrapped_filter_id() -> FilterId {
    USER_RULES_FILTER_LIST_ID
}

#[allow(clippy::field_reassign_with_default)]
/// Make special "User rules" filter
fn make_user_rules_filter_entity() -> FilterEntity {
    let mut user_rules_entity = FilterEntity::default();

    user_rules_entity.filter_id = Some(USER_RULES_FILTER_LIST_ID);
    user_rules_entity.group_id = SERVICE_GROUP_ID;
    user_rules_entity.title = String::from("User rules");
    user_rules_entity.is_enabled = true;
    user_rules_entity.version = String::from("1.0.0.0");
    user_rules_entity.is_trusted = true;
    user_rules_entity.set_is_user_title(true);
    user_rules_entity.set_is_user_description(true);

    user_rules_entity
}

/// Creates an empty rule list for the user rules filter.
/// This should not be deleted, as user rules are not set in the usual way when downloaded from the `download_url`.
fn create_user_rules_rules_list_entity() -> RulesListEntity {
    RulesListEntity::make(USER_RULES_FILTER_LIST_ID, string!(), 0)
}

/// Creates a special group for custom filters.
fn create_group_entity_for_custom_filters() -> FilterGroupEntity {
    FilterGroupEntity {
        group_id: CUSTOM_FILTERS_GROUP_ID,
        name: "Custom filters".to_string(),
        display_number: 0,
    }
}

/// Makes specific queries to an empty database with a schema
pub(crate) fn db_bootstrap(transaction: &mut Transaction) -> rusqlite::Result<()> {
    let filter_entity = make_user_rules_filter_entity();
    let rule_entity = create_user_rules_rules_list_entity();
    let custom_group = create_group_entity_for_custom_filters();

    FilterRepository::new().insert(transaction, &[filter_entity])?;
    RulesListRepository::new().insert(transaction, &[rule_entity])?;
    FilterGroupRepository::new().insert(transaction, &[custom_group])
}