-#ifndef SQUID_REFRESHPATTERN_H_
-#define SQUID_REFRESHPATTERN_H_
/*
- * SQUID Web Proxy Cache http://www.squid-cache.org/
- * ----------------------------------------------------------
- *
- * Squid is the result of efforts by numerous individuals from
- * the Internet community; see the CONTRIBUTORS file for full
- * details. Many organizations have provided support for Squid's
- * development; see the SPONSORS file for full details. Squid is
- * Copyrighted (C) 2001 by the Regents of the University of
- * California; see the COPYRIGHT file for full details. Squid
- * incorporates software developed and/or copyrighted by other
- * sources; see the CREDITS file for full details.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+ * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
*
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
*/
-/// a representation of a refresh pattern. Currently a POD.
+#ifndef SQUID_REFRESHPATTERN_H_
+#define SQUID_REFRESHPATTERN_H_
+
+#include "base/RegexPattern.h"
+
+#include <memory>
+
+/// a representation of a refresh pattern.
class RefreshPattern
{
+ MEMPROXY_CLASS(RefreshPattern);
+
public:
- const char *pattern;
- regex_t compiled_pattern;
+
+ /*
+ * Defaults:
+ * MIN NONE
+ * PCT 20%
+ * MAX 3 days
+ */
+#define REFRESH_DEFAULT_MAX static_cast<time_t>(259200)
+
+ using RegexPointer = std::unique_ptr<RegexPattern>;
+
+ // If given a regex, becomes its owner, creating an explicit refresh_pattern
+ // rule. Otherwise, creates an implicit/default refresh_pattern rule.
+ explicit RefreshPattern(RegexPointer aRegex):
+ min(0), pct(0.20), max(REFRESH_DEFAULT_MAX),
+ next(nullptr),
+ max_stale(0),
+ regex_(std::move(aRegex))
+ {
+ memset(&flags, 0, sizeof(flags));
+ }
+
+ ~RefreshPattern() {
+ while (RefreshPattern *t = next) {
+ next = t->next;
+ t->next = nullptr;
+ delete t;
+ }
+ }
+
time_t min;
double pct;
time_t max;
RefreshPattern *next;
struct {
- bool icase;
bool refresh_ims;
bool store_stale;
#if USE_HTTP_VIOLATIONS
bool reload_into_ims;
bool ignore_reload;
bool ignore_no_store;
- bool ignore_must_revalidate;
bool ignore_private;
- bool ignore_auth;
#endif
} flags;
int max_stale;
+
+ // statistics about how many matches this pattern has had
+ mutable struct stats_ {
+ stats_() : matchTests(0), matchCount(0) {}
+
+ uint64_t matchTests;
+ uint64_t matchCount;
+ // TODO: some stats to indicate how useful/less the flags are would be nice.
+ } stats;
+
+ /// reports configuration excluding trailing options
+ void printHead(std::ostream &) const;
+
+ /// reports the configured pattern or a fake pattern of the implicit rule
+ void printPattern(std::ostream &os) const;
+
+ // TODO: Refactor external refresh_pattern rules iterators to make private.
+ /// configured regex; do not use except when iterating configured rules
+ const RegexPattern ®ex() const;
+
+private:
+ /// configured regex or, for the implicit refresh_pattern rule, nil
+ RegexPointer regex_;
};
+inline std::ostream &
+operator <<(std::ostream &os, const RefreshPattern &r)
+{
+ r.printHead(os);
+ return os;
+}
+
#endif /* SQUID_REFRESHPATTERN_H_ */
+