You can extend the tool by implementing your own logic via the Rule class. A custom rule follows a specific lifecycle:

1. Rule.check(*args, **kwargs): Verifies the rule configuration and can call other services.
2. Rule.aql_add_filter(filters): Adds Artifactory Query Language (AQL) expressions to the query.
3. Rule.aql_add_text(aql): Adds raw text to the resulting AQL query.
4. Rule.filter(artifacts): Processes the list of artifacts returned by Artifactory. Crucially, this method must return the list of artifacts that are intended to be REMOVED.
   • To prevent an artifact from being deleted, use the artifacts.keep(artifact) method.

To use a custom rule, create a Python file (e.g., myrule.py) in the same directory as your artifactory-cleanup.yaml, define your class inheriting from Rule, and call register(YourClassName) at the end of the file.

# myrule.py
from typing import List
from artifactory_cleanup import register
from artifactory_cleanup.rules import Rule, ArtifactsList

class MySimpleRule(Rule):
    """
    This doc string is used as rule title
    """
    def __init__(self, my_param: str, value: int):
        self.my_param = my_param
        self.value = value

    def aql_add_filter(self, filters: List) -> List:
        return filters

    def filter(self, artifacts: ArtifactsList) -> ArtifactsList:
        # You can make requests to artifactory by using self.session:
        # url = f"/api/storage/{self.repo}"
        # r = self.session.get(url)
        # r.raise_for_status()
        return artifacts

# Register your rule in the system
register(MySimpleRule)

To safely clean up Conan repositories without breaking metadata, use a two-policy approach:

1. Policy 1: Removes actual files but preserves metadata files (using ExcludeFilename for patterns like .timestamp or index.json).
2. Policy 2: Identifies folders that contain only metadata files and removes the empty folders to fix the index.

Example Configuration:

artifactory-cleanup:
  server: https://repo.example.com/artifactory
  user: $ARTIFACTORY_USERNAME
  password: $ARTIFACTORY_PASSWORD

  policies:
    - name: Conan - delete files older than 60 days
      rules:
        - rule: Repo
          name: "conan-testing"
        - rule: DeleteNotUsedSince
          days: 60
        - rule: ExcludeFilename
          masks:
            - ".timestamp"
            - "index.json"
    - name: Conan - delete empty folders (to fix the index)
      rules:
        - rule: Repo
          name: "conan-testing"
        - rule: DeleteEmptyFolders
        - rule: ExcludeFilename
          masks:
            - ".timestamp"
            - "index.json"

Common rules used to target specific repositories or artifacts based on properties.

# Common Rules

- `Repo` - Apply the rule to one repository. If no name is specified, it is taken from the rule name (in `CleanupPolicy` definition)

```yaml
- rule: Repo
  name: reponame

OR - if you have a single policy for the repo - you can name the policy as reponame

Both configurations are equal

policies:

• name: reponame rules:
  • rule: Repo

- `RepoList` - Apply the policy to list of repositories.

```yaml
- rule: RepoList
  repos:
    - repo1
    - repo2
    - repo3

• RepoByMask - Apply rule to repositories matching by mask

- rule: RepoByMask
  mask: "*.banned"

• PropertyEq - Delete repository artifacts only with a specific property value (property_key is the name of the parameter, property_value is the value)

- rule: PropertyEq
  property_key: key-name
  property_value: 1

• PropertyNeq - Delete repository artifacts only if the value != specified. If there is no value, delete it anyway. Allows you to specify the deletion flag do_not_delete = 1.

- rule: PropertyNeq
  property_key: key-name
  property_value: 1

Rules specifically designed for cleaning up Docker images in Artifactory.

# Docker Rules

- `DeleteDockerImagesOlderThan` - Delete docker images that are older than N days

```yaml
- rule: DeleteDockerImagesOlderThan
  days: 1

• DeleteDockerImagesOlderThanNDaysWithoutDownloads - Deletes docker images that are older than N days and have not been downloaded

- rule: DeleteDockerImagesOlderThanNDaysWithoutDownloads
  days: 1

• DeleteDockerImagesNotUsed - Removes Docker image not downloaded since N days

- rule: DeleteDockerImagesNotUsed
  days: 1

• IncludeDockerImages - Apply to docker images with the specified names and tags

- rule: IncludeDockerImages
  masks: "*singlemask*"
- rule: IncludeDockerImages
  masks:
    - "*production*"
    - "*release*"

• ExcludeDockerImages - Exclude Docker images by name and tags.

- rule: ExcludeDockerImages
  masks:
    - "*production*"
    - "*release*"

• KeepLatestNVersionImagesByProperty(count=N, custom_regexp='some-regexp', number_of_digits_in_version=X) - Leaves N Docker images with the same major. (^\d+\.\d+\.\d+$) is the default regexp how to determine version which matches semver 1.1.1. If you need to add minor then set number_of_digits_in_version to 2 or if patch then set to 3 (by default we match major, which 1). Semver tags prefixed with v are supported by updating the regexp to include an optional v in the expression (e.g., (^v?\d+\.\d+\.\d+$)).

- rule: KeepLatestNVersionImagesByProperty
  count: 1
  custom_regexp: "[^\\d][\\._]((\\d+\\.)+\\d+)"

• KeepLatestNDockerImages(count=N) - Leaves N most recently updated Docker image digests. This ensures all tags matching the same digest is kept.

- rule: KeepLatestNDockerImages
  count: 1

• DeleteDockerImageIfNotContainedInProperties(docker_repo='docker-local', properties_prefix='my-prop', image_prefix=None, full_docker_repo_name=None) - Remove Docker image, if it is not found in the properties of the artifact repository.

• DeleteDockerImageIfNotContainedInPropertiesValue(docker_repo='docker-local', properties_prefix='my-prop', image_prefix=None, full_docker_repo_name=None) - Remove Docker image, if it is not found in the properties of the artifact repository.