← Back to branch summary

~alinuxninja/nginx-edge/trunk

« back to all changes in this revision

Viewing changes to debian/modules/ngx_pagespeed/psol/include/net/instaweb/rewriter/public/image_url_encoder.h

  • Committer: Vivian
  • Date: 2015-12-04 18:20:11 UTC
  • Revision ID: git-v1:a36f2bc32e884f7473b3a47040e5411306144d7d
* Do not extract psol.tar.gz

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/modules/ngx_pagespeed/psol/include/net/instaweb/rewriter/public/image_url_encoder.h
1
 
/*
2
 
 * Copyright 2010 Google Inc.
3
 
 *
4
 
 * Licensed under the Apache License, Version 2.0 (the "License");
5
 
 * you may not use this file except in compliance with the License.
6
 
 * You may obtain a copy of the License at
7
 
 *
8
 
 *      http://www.apache.org/licenses/LICENSE-2.0
9
 
 *
10
 
 * Unless required by applicable law or agreed to in writing, software
11
 
 * distributed under the License is distributed on an "AS IS" BASIS,
12
 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
 
 * See the License for the specific language governing permissions and
14
 
 * limitations under the License.
15
 
 */
16
 
// Author: jmaessen@google.com (Jan Maessen)
17
 
 
18
 
#ifndef NET_INSTAWEB_REWRITER_PUBLIC_IMAGE_URL_ENCODER_H_
19
 
#define NET_INSTAWEB_REWRITER_PUBLIC_IMAGE_URL_ENCODER_H_
20
 
 
21
 
#include "net/instaweb/rewriter/cached_result.pb.h"
22
 
#include "net/instaweb/util/public/basictypes.h"
23
 
#include "net/instaweb/util/public/gtest_prod.h"
24
 
#include "net/instaweb/util/public/string.h"
25
 
#include "net/instaweb/util/public/string_util.h"
26
 
#include "net/instaweb/util/public/url_segment_encoder.h"
27
 
 
28
 
namespace net_instaweb {
29
 
 
30
 
class GoogleUrl;
31
 
class RequestProperties;
32
 
class RewriteDriver;
33
 
class RewriteOptions;
34
 
class MessageHandler;
35
 
 
36
 
// This class implements the encoding of image urls with optional additional
37
 
// dimension metadata.  It basically prepends characters indicating image
38
 
// dimensions on the page, webp eligibility, and mobile user agent eligibility
39
 
// (this information is conveyed in the ResourceContext).
40
 
//   http://...path.../50x75xurl...  No webp, image is 50x75 on page
41
 
//   http://...path.../50x75wurl...  Webp requested, image is 50x75 on page
42
 
//   http://...path.../50x75mxurl...
43
 
//       No webp, for mobile user agent, image is 50x75 on page
44
 
//   http://...path.../50x75mwurl...
45
 
//       Webp requested, for mobile user agent, image is 50x75 on page
46
 
//   http://...path.../50xNxurl..    No webp, image is 50 wide, no height given
47
 
//   http://...path.../50xNwurl...   Webp, image is 50 wide, no height given
48
 
//   http://...path.../Nx75xurl...   No webp, image is 75 high, no width given
49
 
//   http://...path.../Nx75wurl...   Webp, image is 75 high, no width given.
50
 
//   http://...path.../50xNmxurl..   No webp, image is 50 wide, mobile
51
 
//   http://...path.../50xNmwurl...  Webp, image is 50 wide, mobile
52
 
//   http://...path.../Nx75mxurl...  No webp, image is 75 high, mobile
53
 
//   http://...path.../Nx75mwurl...  Webp, image is 75 high, mobile
54
 
//   http://...path.../xurl...  Page does not specify both dimensions.  No webp.
55
 
//   http://...path.../wurl...  Webp requested, page missing dimensions.
56
 
//   http://...path.../xurl...  Page does not specify any dimension.  No webp.
57
 
//   http://...path.../wurl...  Webp requested, page missing either dimension.
58
 
//   http://...path.../mxurl...
59
 
//       No webp, for mobile user agent, page does not specify dimensions.
60
 
//   http://...path.../mwurl...
61
 
//       Webp requested, for mobile user agent, page missing dimensions.
62
 
class ImageUrlEncoder : public UrlSegmentEncoder {
63
 
 public:
64
 
  // Area threshold that determines whether we use
65
 
  // Image*RecompressionQualityForSmallScreens to set WebP/Jpeg quality.
66
 
  // The intent is for phones and small tablets (e.g., Nexus 7) to be in.
67
 
  static const int kSmallScreenSizeThresholdArea;
68
 
 
69
 
  ImageUrlEncoder() {}
70
 
  virtual ~ImageUrlEncoder();
71
 
 
72
 
  virtual void Encode(const StringVector& urls,
73
 
                      const ResourceContext* dim,
74
 
                      GoogleString* rewritten_url) const;
75
 
 
76
 
  virtual bool Decode(const StringPiece& url_segment,
77
 
                      StringVector* urls,
78
 
                      ResourceContext* dim,
79
 
                      MessageHandler* handler) const;
80
 
 
81
 
  // Set LibWebp level according to the user agent.
82
 
  // TODO(poojatandon): Pass a user agent object with its webp-cabaple bits
83
 
  // pre-analyzed (not just the string from the request headers), since
84
 
  // checking webp level related code doesn't belong here.
85
 
  static void SetLibWebpLevel(const RewriteOptions& options,
86
 
                              const RequestProperties& request_properties,
87
 
                              ResourceContext* resource_context);
88
 
 
89
 
  // Sets webp and mobile capability in resource context.
90
 
  //
91
 
  // The parameters to this method are urls, rewrite options & resource context.
92
 
  // Since rewrite options are not changed, we have passed const reference and
93
 
  // resource context is modified and can be NULL, hence we pass as a pointer.
94
 
  static void SetWebpAndMobileUserAgent(const RewriteDriver& driver,
95
 
                                        ResourceContext* context);
96
 
 
97
 
  // Determines whether the given URL is a pagespeed-rewritten webp URL.
98
 
  static bool IsWebpRewrittenUrl(const GoogleUrl& gurl);
99
 
 
100
 
  // Flag whether this device has a small screen, which determines what
101
 
  // Jpeg/WebP quality to use.
102
 
  static void SetSmallScreen(const RewriteDriver& driver,
103
 
                             ResourceContext* context);
104
 
 
105
 
  // Set context for screen resolution.
106
 
  static void SetUserAgentScreenResolution(
107
 
      RewriteDriver* driver, ResourceContext* context);
108
 
 
109
 
  // Helper function to generate Metadata cache key from ResourceContext.
110
 
  static GoogleString CacheKeyFromResourceContext(
111
 
      const ResourceContext& resource_context);
112
 
 
113
 
  static bool HasDimensions(const ResourceContext& data) {
114
 
    return (data.has_desired_image_dims() &&
115
 
            HasValidDimensions(data.desired_image_dims()));
116
 
  }
117
 
 
118
 
  static bool HasValidDimensions(const ImageDim& dims) {
119
 
    return (dims.has_width() && dims.has_height());
120
 
  }
121
 
 
122
 
  static bool HasDimension(const ResourceContext& data) {
123
 
    return (data.has_desired_image_dims() &&
124
 
            HasValidDimension(data.desired_image_dims()));
125
 
  }
126
 
 
127
 
  static bool HasValidDimension(const ImageDim& dims) {
128
 
    return (dims.has_width() || dims.has_height());
129
 
  }
130
 
 
131
 
 private:
132
 
  FRIEND_TEST(ImageRewriteTest, SquashImagesForMobileScreen);
133
 
  FRIEND_TEST(ImageUrlEncoderTest, UserAgentScreenResolution);
134
 
 
135
 
  // Returns true if screen width and height are normalized according to a
136
 
  // predefined list of screen resolutions (see implementation header document
137
 
  // for more details).
138
 
  static bool GetNormalizedScreenResolution(
139
 
      int screen_width, int screen_height, int* normalized_width,
140
 
      int* normalized_height);
141
 
 
142
 
  DISALLOW_COPY_AND_ASSIGN(ImageUrlEncoder);
143
 
};
144
 
 
145
 
}  // namespace net_instaweb
146
 
 
147
 
#endif  // NET_INSTAWEB_REWRITER_PUBLIC_IMAGE_URL_ENCODER_H_