Skip to content

Commit

Permalink
Merge pull request #33 from Kentico/kile-lindgren-master
Browse files Browse the repository at this point in the history 
Review changes for PR31: Fixing the generated Canonical Link
  • Loading branch information
@MarecekF
MarecekF authored Sep 6, 2018
2 parents 57cb488 + c130756 commit 22adb47
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 25 deletions.
2 changes: 1 addition & 1 deletion CMS/CMSModules/Kentico.AcceleratedMobilePages/Default.aspx.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ protected void Page_Load(object sender, EventArgs e)
CurrentMaster.HeaderActions.Enabled = false;
}

if (Node != null && !URLHelper.IsPostback())
if (Node != null && !RequestHelper.IsPostBack())
{
ReloadData();
}
Expand Down
30 changes: 24 additions & 6 deletions Kentico.AcceleratedMobilePages/AmpFilter.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ public class AmpFilter
private string customElementsScripts;


/// <summary>
/// Returns URL protocol prefix depending on the current connection
/// </summary>
private string ConnectionProtocolPrefix => CMSHttpContext.Current.Request.IsSecureConnection ? Constants.P_HTTPS : Constants.P_HTTP;


/// <summary>
/// If the filter is enabled for current page, final HTML will be modified
/// </summary>
Expand Down Expand Up @@ -67,10 +73,9 @@ private string TransformToAmpHtml(string finalHtml)
/// <param name="finalHtml">Final HTML string</param>
private string AppendAmpHtmlLink(string finalHtml)
{
string ampLink = (CMSHttpContext.Current.Request.IsSecureConnection ? Constants.P_HTTPS : Constants.P_HTTP) +
string ampLink = ConnectionProtocolPrefix +
Settings.AmpFilterDomainAlias +
(DocumentContext.CurrentPageInfo.DocumentUrlPath ?? DocumentContext.CurrentAliasPath) +
Settings.CmsFriendlyUrlExtension;
GetDocumentPath();
string metaTag = String.Format(Constants.AMP_AMP_HTML_LINK, ampLink) + Constants.NEW_LINE;
// Insert meta tag
finalHtml = Regex.Replace(finalHtml, "</head>", metaTag + "</head>");
Expand Down Expand Up @@ -234,9 +239,9 @@ private string InsertCompulsoryMarkupAndCss(string finalHtml)
string styles = GetStylesheetText();

// Create a link pointing to the regular HTML version of the page
string canonicalLink = (CMSHttpContext.Current.Request.IsSecureConnection ? Constants.P_HTTPS : Constants.P_HTTP) +
SiteContext.CurrentSite.DomainName + (DocumentContext.CurrentPageInfo.DocumentUrlPath ?? DocumentContext.CurrentAliasPath) +
Settings.CmsFriendlyUrlExtension;
string canonicalLink = ConnectionProtocolPrefix +
SiteContext.CurrentSite.DomainName +
GetDocumentPath();

// Extend the <head> tag with the compulsory markup and CSS styles
headTag += Constants.NEW_LINE +
Expand Down Expand Up @@ -360,5 +365,18 @@ private void RemoveAttribute(HtmlDocument doc, string xPath, string attrName)
}
}
}


/// <summary>
/// Returns path of the currently processed document
/// </summary>
private string GetDocumentPath()
{
var documentPath = !String.IsNullOrEmpty(DocumentContext.CurrentPageInfo.DocumentUrlPath)
? DocumentContext.CurrentPageInfo.DocumentUrlPath
: DocumentContext.CurrentAliasPath;

return documentPath + Settings.CmsFriendlyUrlExtension;
}
}
}
2 changes: 1 addition & 1 deletion Kentico.AcceleratedMobilePages/Constants.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public class Constants
"//meta[translate(@name,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"viewport\"]",
"//script[not(translate(@type,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"application/ld+json\") and not(@async and @custom-element)]",
"//input[translate(@type,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"image\" or translate(@type,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"button\" or translate(@type,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"password\" or translate(@type,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"file\"]",
"//link[translate(@rel,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"preconnect\" or translate(@rel,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"prerender\" or translate(@rel,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"prefetch\"]",
"//link[translate(@rel,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"preconnect\" or translate(@rel,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"prerender\" or translate(@rel,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"prefetch\" or (translate(@rel,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"preload\" and translate(@as,'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz')=\"style\") ]",
"//meta[@http-equiv]",
"//a[starts-with(@href,\"javascript:\")][not(contains(@target,\"_blank\"))]",
"//style",
Expand Down
2 changes: 1 addition & 1 deletion Kentico.AcceleratedMobilePages/Settings.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public static class Settings
/// <summary>
/// Gets extensions that the system adds to page URLs on current site.
/// </summary>
public static string CmsFriendlyUrlExtension => SettingsKeyInfoProvider.GetValue(SiteContext.CurrentSiteName + ".CMSFriendlyURLExtension");
public static string CmsFriendlyUrlExtension => SettingsKeyInfoProvider.GetValue(SiteContext.CurrentSiteName + ".CMSFriendlyURLExtension").Split(';')[0];


/// <summary>
Expand Down
35 changes: 19 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Accelerated Mobile Pages Module (AMP Filter) is a custom module for Kentico CMS and EMS. It consists of an [Output Filter](https://docs.kentico.com/k11/configuring-kentico/using-output-filters) for transforming regular HTML to AMP HTML format and a macro method that makes it easy to adjust and fine-tune the rendered output. The project is based on a [master thesis (EN)](https://is.muni.cz/th/409956/fi_m/?lang=en) of Daniel Minarik ([full text](https://is.muni.cz/th/409956/fi_m/thesis.pdf)).

:bulb: Read [how we implemented AMP](https://devnet.kentico.com/articles/google-amping-the-kentico-advantage-site) on [Kentico Advantage website](http://amp.advantage.kentico.com/).
:bulb: Read [how we implemented AMP](https://devnet.kentico.com/articles/google-amping-the-kentico-advantage-site) on Kentico Advantage website.

## Usage

Expand Down Expand Up @@ -39,7 +39,7 @@ There are several ways of including cascading style sheets into an AMP page:
* If none of the previous options is set, the AMP Filter will use the regular CSS stylesheet assigned to the page (either the site's default stylesheet or the page-specifc one). This option is not recommended, as the stylesheet could be bigger than 50kB (e.g., if it contains styles for the whole website).

### Further customization of AMP pages
The AMP standard offers a lot of components or tags which do not have an ordinary HTML equivalent, and therefore, they can't be automatically injected or replaced in the page's source code.
The AMP standard offers a lot of components or tags which do not have an ordinary HTML equivalent, and therefore, they can't be automatically injected or replaced in the page's source code.

You can use the `{% AmpFilter.IsAmpPage() %}` macro to find out whether the AMP Filter is enabled and active on the current page. This is useful for showing and hiding different parts of a web page. To do that, use the macro as a visibility condition of a web part.

Expand All @@ -66,7 +66,7 @@ Some advanced replacements (which were not possible to implement using the HtmlA

### Cascading style sheets
The AMP Filter does not transform cascading stylesheets in any way. The developer must ensure that the stylesheet complies with [AMP HTML specification - stylesheet restrictions](https://www.ampproject.org/docs/reference/spec#stylesheets).


### Global settings
AMP Filter has two types of global settings:
Expand All @@ -91,7 +91,7 @@ Even when using the AMP Filter there are still some things that need to be handl
* For simple sites with CSS totalling no more than 50kB in size (and adhering to the official [AMP rules](https://www.ampproject.org/docs/reference/spec#stylesheets)), there's no need to create AMP-specific stylesheets - the sites will work correctly with the regular stylesheets.

* The AMP filter is mainly intened for simple, static pages, i.e. pages containing regular HTML. Only the `<img>`, `<video>`, `<audio>`, and `<iframe>` interactive elements (adhering to the [AMP HTML Specification](https://www.ampproject.org/docs/fundamentals/spec)) are allowed. Pages that fulfill these requirements will be transformed into the AMP format.

* The static `<form>` element used by ASP.NET web forms to store metadata and viewstate information is also converted to the AMP format. However, standard `<form>` elements included in the page's markup will not be submitted and processed by the server at all. To implement standard on-line form functionality (via the `<form>` tag), refer to the [amp-form](https://www.ampproject.org/docs/reference/components/amp-form) section of the official AMP documentation.

## Developing the module and contributing
Expand All @@ -103,38 +103,41 @@ Even when using the AMP Filter there are still some things that need to be handl
1. Navigate to the root of the project (where the .sln file is)
1. Fork this repo
1. Init a git repo and fetch the web part

git init
git remote add origin https://github.com/OWNER/kentico-amp.git
git fetch
git checkout origin/master -ft

1. Restore DB data

Kentico\CMS\bin\ContinuousIntegration.exe -r

1. Open the web project in Visual Studio
1. Add `Kentico.AcceleratedMobilePages\Kentico.AcceleratedMobilePages.csproj` to the solution
1. Add `Kentico.AcceleratedMobilePages.Publisher\Kentico.AcceleratedMobilePages.Publisher.csproj` to the solution
1. Add reference from CMSApp to Kentico.AcceleratedMobilePages.csproj
1. Add reference from CMSApp to Kentico.AcceleratedMobilePages.Publisher.csproj
1. Build the solution
1. Open the solution in Visual Studio
1. Add the following projects to the solution:
* `Kentico.AcceleratedMobilePages\Kentico.AcceleratedMobilePages.csproj`
* `Kentico.AcceleratedMobilePages.Publisher\Kentico.AcceleratedMobilePages.Publisher.csproj`
1. Reference the added projects from the CMSApp project:
1. Right-click the CMSApp project and select Add -> Reference...
1. Click Browse... and locate the projects on your filesystem
1. Click Add
1. Rebuild the solution
1. [Resign all macros](https://docs.kentico.com/k11/macro-expressions/troubleshooting-macros/working-with-macro-signatures)
1. Optional: Assign the module to one or more sites
1. Make changes
1. Use combination of `git add`, `git commit` and `git push` to transfer your changes to GitHub

git status
git commit -a -m "Fix XY"
git push

1. Submit a pull request

## Compatibility
Tested with Kentico 11.0 (net46).

## [Questions & Support](https://github.com/Kentico/Home/blob/master/README.md)

## [License](https://github.com/Kentico/kentico-amp/blob/master/LICENSE.txt)

![Analytics](https://kentico-ga-beacon.azurewebsites.net/api/UA-69014260-4/Kentico/kentico-amp?pixel)
![Analytics](https://kentico-ga-beacon.azurewebsites.net/api/UA-69014260-4/Kentico/kentico-amp?pixel)

0 comments on commit 22adb47

Please sign in to comment.