Source Format Enforcement (#763)

[thirdparty/squid.git] / src / mime_header.h

diff --git a/src/mime_header.h b/src/mime_header.h
index 1a9a5f6b3eb9fb5ed5639cd1002e0fa4a72e881b..b71af6dc852a7e9f97f627433312ad318a55d0d7 100644 (file)
--- a/src/mime_header.h
+++ b/src/mime_header.h
@@ -1,38 +1,48 @@
 /*
- * DEBUG: section 25    MiME Header Parsing
- * AUTHOR: Harvest Derived
+ * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
  *
- * 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.
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
+ */
+
+/* DEBUG: section 25    MiME Header Parsing */
+
+#ifndef SQUID_MIME_HEADER_H_
+#define SQUID_MIME_HEADER_H_
+
+/**
+ * Scan for the end of mime header block.
  *
- *  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.
+ * Which is one of the following octet patterns:
+ * - CRLF CRLF, or
+ * - CRLF LF, or
+ * - LF CRLF, or
+ * - LF LF or,
+ *   if mime header block is empty:
+ * - LF or
+ * - CRLF
  *
- *  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.
+ * Also detects whether a obf-fold pattern exists within the mime block
+ * - CR*LF (SP / HTAB)
  *
+ * \param containsObsFold will be set to true if obs-fold pattern is found.
  */
+size_t headersEnd(const char *, size_t, bool &containsObsFold);
 
-#ifndef SQUID_MIME_HEADER_H_
-#define SQUID_MIME_HEADER_H_
+inline size_t
+headersEnd(const SBuf &buf, bool &containsObsFold)
+{
+    return headersEnd(buf.rawContent(), buf.length(), containsObsFold);
+}
 
-size_t headersEnd(const char *, size_t);
+/// \deprecated caller needs to be fixed to handle obs-fold
+inline size_t
+headersEnd(const char *buf, size_t sz)
+{
+    bool ignored;
+    return headersEnd(buf, sz, ignored);
+}
 
 #endif /* SQUID_MIME_HEADER_H_ */
+