🐛 `QUOTA` support is broken for types other than `STORAGE`

Ouverte
  • Quelque chose ne va pas ?
#622 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
30/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
ruby
Domaine
api, networking

Piste de recherche

Commencez par l’analyseur de réponses de quota et les points d’entrée Net::IMAP #getquota, #getquotaroot et #setquota, en utilisant RFC2087 et RFC9208 comme références du protocole. Le travail est considéré comme terminé lorsque plusieurs types de ressources sont analysés sans plantage, que QuotaResponse et le comportement rétrocompatible sont pris en charge via la configuration, et que la définition des quotas accepte les types de ressources demandés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

bug

Support for the QUOTA extension is broken in several ways: it assumes STORAGE is the only possible quota resource type (which was not true, even for RFC2087) and the response parser will crash the connection if multiple resource types are returned. Fixing this is backward incompatible, so it will need to be hidden behind new config attribute.

Response Parser

Currently, the response parser for quota-response only allows zero or one quota-resource. It implicitly assumes that resource type is STORAGE, so it doesn't store the resource type. And it crashes for more than one resource type.

  • QUOTA response should be parsed consistently with RFC2087 and RFC9208, into a new QuotaResponse type.
Response Data

MailboxQuota must be deprecated: the #mailbox attribute is misleadingly named (it should be #quota_root), the class is misleadingly named (again: it provides information about a "quota root", which does not have a 1-to-1 relationship with mailbox), and it can only list usage and limit for a single resource type

  • QuotaResponse = Data.define(:quota_root, :resources)
    • #to_deprecated_mailbox_quota for backwards compatibility
  • QuotaResponse::Resource = Data.define(:name, :usage, :limit)
Net::IMAP command methods
  • #getquota: Use use_deprecated_mailbox_quota config:
    • when :silent, return only the STORAGE resource (nil if no STORAGE resource)
    • when true, same as :silent but issue a warning for non STORAGE resource types
    • when false, return QuotaResponse rather than MailboxQuota
  • #getquotaroot: Use use_deprecated_mailbox_quota config (same as #getquota)
  • #setquota: support any number of any resource types via *rest args
Additional

Separately from this bug, there are some other QUOTA related issues (TODO: move these to separate issues/PRs):

  • RFC9208 support
    • new capabilities: QUOTA=RES-* and QUOTASET
      • document at class level, and on all three quota methods
    • QuotaResponse: Add accessors "attributes" for every type in the IANA quota resource type registry:
      • def storage = resources.find { "STORAGE".casecmp?(it.name) }
      • def message = resources.find { "MESSAGE".casecmp?(it.name) }
      • def mailbox = resources.find { "MAILBOX".casecmp?(it.name) }
      • def annotation_storage = resources.find { "ANNOTATION-STORAGE".casecmp?(it.name) }
    • new response code: OVERQUOTA
      • document on ResponseCode class
      • add (trivial) support in response parser
    • #setquota:
      • support IANA-registered resource types via keyword args
  • #getquotaroot:
    • Rather than return an array of mixed MailboxQuotaRoot and QuotaResponse objects, return a single hash-like object that combines them.
      • Config#getquotaroot_returns_quotaroot_data
    • Config#setquota_returns_quota_responses => return matching untagged QUOTA responses
Langage dominant
Ruby
Étoiles
121
Forks
47
Merge moyen
19 h 25 min
PR mergées (30 j)
3

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ruby/net-imap

Toutes les issues de ruby/net-imap

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.