{"type":"doc","content":[{"type":"paragraph","content":[{"text":"If you are offering your plugin on the ","type":"text"},{"text":"SmartStore Community Marketplace","type":"text","marks":[{"type":"link","attrs":{"href":"http://community.smartstore.com/index.php?/files/"}}]},{"text":", you can easily make it licensable. If a plugin is licensable, it will behave as follows:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A shop administrator can use your plugin for free for 30 days (demonstration mode). After this period, the plugin has to be licensed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A shop administrator receives a license key after purchasing the plugin on the ","type":"text"},{"text":"SmartStore Marketplace","type":"text","marks":[{"type":"link","attrs":{"href":"http://community.smartstore.com/index.php?/files/"}}]},{"text":". To activate the license key, it has to be entered in the SmartStore.NET backend (","type":"text"},{"text":"Plugins > Manage Plugins","type":"text","marks":[{"type":"strong"}]},{"text":"). A key is only valid for the IP address that originally activated it.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The license status is periodically checked to ensure that nobody is misusing your plugin.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The following steps are necessary to make a plugin licensable:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add a reference of ","type":"text"},{"text":"lib\\SmartStore.Licensing","type":"text","marks":[{"type":"code"}]},{"text":"\\SmartStore.Licensing.dll","type":"text","marks":[{"type":"code"}]},{"text":" to your plugin.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Open your main plugin class (typically derived from one of the base plugin classes: ","type":"text"},{"text":"BasePlugin","type":"text","marks":[{"type":"code"}]},{"text":" or just ","type":"text"},{"text":"IPlugin","type":"text","marks":[{"type":"code"}]},{"text":".). Decorate it with the ","type":"text"},{"text":"LicensableModule","type":"text","marks":[{"type":"code"}]},{"text":" attribute.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Decorate your controllers or action methods with the ","type":"text"},{"text":"LicenseRequired","type":"text","marks":[{"type":"code"}]},{"text":" filter attribute, or alternatively, call ","type":"text"},{"text":"LicenseChecker.Check[State]()","type":"text","marks":[{"type":"code"}]},{"text":" in your code.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"The LicensableModule Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"The attribute is intended to mark a plugin as a licensed piece of code where the user has to enter a license key that has to be activated. ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Definition","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]\npublic class LicensableModuleAttribute : Attribute\n{\n\t///

\n\t/// Whether one license (key) is valid for all stores. Otherwise a new key is required for each store.\n\t///

\n\tpublic bool HasSingleLicenseForAllStores { get; set; }\t\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"The LicenseRequired Filter Attribute","type":"text"}]},{"type":"paragraph","content":[{"text":"You can decorate either a whole controller class or just a single action method with the ","type":"text"},{"text":"LicenseRequired ","type":"text","marks":[{"type":"code"}]},{"text":"attribute. This attribute internally calls ","type":"text"},{"text":"LicenseChecker.Check()","type":"text","marks":[{"type":"code"}]},{"text":" right before your action is processed, giving it the opportunity to block the action.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#003366"}}]},{"text":" If the license isn't valid, the ","type":"text"},{"text":"LicenseRequiredView","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"},{"type":"code"}]},{"text":"will be rendered by default, which you can override by setting the property ","type":"text"},{"text":"ViewName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"em"},{"type":"code"}]},{"text":"on the attribute. Alternatively, you could just display a notification for which you can use the properties ","type":"text"},{"text":"NotifyOnly","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text","marks":[{"type":"code"},{"type":"em"}]},{"text":"NotificationMessage","type":"text","marks":[{"type":"code"}]},{"text":" and","type":"text"},{"text":" ","type":"text","marks":[{"type":"em"}]},{"text":"NotificationMessageType","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text","marks":[{"type":"em"}]},{"text":"Ajax requests will be recognized automatically, and a suitable response will be generated according to the negotiated content type (either JSON or HTML).","type":"text"}]},{"type":"paragraph","content":[{"text":"If you want to block certain methods or even your entire plugin when it is in demo mode, you need to set the property ","type":"text"},{"text":"BlockDemo","type":"text","marks":[{"type":"em"}]},{"text":" to ","type":"text"},{"text":"True, ","type":"text","marks":[{"type":"em"}]},{"text":"otherwise everything will be accessible in the demo mode, as the value of ","type":"text"},{"text":"BlockDemo","type":"text","marks":[{"type":"em"}]},{"text":" is ","type":"text"},{"text":"False","type":"text","marks":[{"type":"em"}]},{"text":" by default.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Definition","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = true, AllowMultiple = true)]\npublic class LicenseRequiredAttribute : ActionFilterAttribute\n{\n\t///

\n\t/// Plugin system name\n\t///

\n\tpublic string PluginSystemName { get; set; }\n\n\t///

\n\t/// Name of layout view for \"License Required\" message. \"~/Views/Shared/_ColumnsOne.cshtml\" by default.\n\t///

\n\tpublic string MasterName { get; set; }\n\n\n\t///

\n\t/// Name of view for \"License Required\" message. \"LicenseRequired\" by default.\n\t///

\n\tpublic string ViewName { get; set; }\n\n\t///

\n\t/// Whether to render an empty result if the plugin is in an unlicensed state.\n\t///

\n\tpublic bool EmptyResultWhenUnlicensed { get; set; }\n\n\t///

\n\t/// Whether to block the request if license is in demo mode.\n\t///

\n\tpublic bool BlockDemo { get; set; }\n\n\t///

\n\t/// Whether to only output a notification message and not to replace the action result.\n\t///

\n\tpublic bool NotifyOnly { get; set; }\n\n\t///

\n\t/// A message to output if the plugin is in an unlicensed state.\n\t///

\n\tpublic string NotificationMessage { get; set; }\n\n\t///

\n\t/// The type of a notification message. Default is 'error'.\n\t///

\n\tpublic string NotificationMessageType { get; set; }\n\t...","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"The License Checker","type":"text"}]},{"type":"paragraph","content":[{"text":"The license checker is a set of static functions for license validation within ","type":"text"},{"text":"SmartStore.Licensing.dll","type":"text","marks":[{"type":"code"}]},{"text":". As a plugin developer, you probably get into situations where you want to check the license status explicitly - that's what the license checker is for. Always provide the system name of the plugin, not the system name of a provider.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"LicenseChecker.CheckState","type":"text","marks":[{"type":"textColor","attrs":{"color":"#444444"}}]}]},{"type":"paragraph","content":[{"text":"Checks the state of a license. This method is an overload of ","type":"text"},{"text":"LicenseChecker.Check","type":"text","marks":[{"type":"code"}]},{"text":" method. Available states (return values) are ","type":"text"},{"text":"Unlicensed","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"Demo","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"Licensed","type":"text","marks":[{"type":"em"}]},{"text":". ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Definition","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"/// Checks the state of a license. Fails if the request is sent from a different IP address than the one that activated the license.\n/// Plugin system name\n/// Absolute URL\n/// Licensing state\npublic static LicensingState CheckState(string systemName, string url = null)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Typically, you check the state of the license when you do not need or want any output, or want to cut the output. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"LicenseChecker.Check","type":"text"}]},{"type":"paragraph","content":[{"text":"This is the main method for checking the state of a license. Returns a ","type":"text"},{"text":"LicenseCheckerResult","type":"text","marks":[{"type":"code"}]},{"text":" object with various information about the status check. If you need a stringified version of the result (German and English localization supported), call the ","type":"text"},{"text":"ToString()","type":"text","marks":[{"type":"code"}]},{"text":" method of the returned object. ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Definition","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"/// Checks the state of a license. Fails if the request is send from a different IP address than the one that activated the license.\n/// Plugin system name\n/// Absolute URL\n/// Result of the operation\npublic static LicenseCheckerResult Check(string systemName, string url = null)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"var result = LicenseChecker.Check(\"MyCompany.MyExtraordinaryPlugin\");\nif (result.State == LicensingState.Unlicensed)\n{\n\t// has no active license, thus not allowed to use my plugin\n\tstring outputMessage = result.ToString().Replace(\"\\r\\n\", \"
\");\n\t...","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Usage Scenario","type":"text"}]},{"type":"paragraph","content":[{"text":"Imagine you have developed a plugin to communicate with an ERP system. Furthermore, your plugin transmits data to a web service whenever an order is placed in your shop and consumes another web service to keep your product data up-to-date. If you decide to allow the product data to be updated completely in the demo mode of your plugin, it may be sufficient for the plugin user to import the product data only once. Therefore, you should interrupt the routine that's responsible for updating product data after a certain number of products have been updated. To do so, you would use the ","type":"text"},{"text":"CheckState() ","type":"text","marks":[{"type":"code"}]},{"text":"method, which checks whether the state is ","type":"text"},{"text":"Demo","type":"text","marks":[{"type":"em"}]},{"text":" and stops the routine accordingly (see code example 1). This way, the user can see a demonstration of the actual function without getting the whole pie. Order events should, of course, be processed and transmitted to the ERP system completely for demonstration purposes, as it's way too difficult to keep track of the number of processed orders. However, when the demonstration period is over, no more orders should be processed. Therefore, you would use the ","type":"text"},{"text":"CheckState() ","type":"text","marks":[{"type":"code"}]},{"text":"method to check whether the state is ","type":"text"},{"text":"Unlicensed","type":"text","marks":[{"type":"em"}]},{"text":" and to stop the event accordingly (see code example 2).","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Code Example 1","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"private void ProcessProducts()\n{\n bool isDemo = LicenseChecker.CheckState(\"MyCompany.MyPlugin\") == LicensingState.Demo;\n\t...\n\tif (isDemo) {\n\t\t// leave after 5 products if plugin is in demo mode\n\t\tproducts = products.Take(5);\n\t}\n\tforeach (var product in products)\n\t{\n\t\tUpdateProduct(product);\n\t}\n\t...","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Code Example 2","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public class EventConsumer : IConsumer>\n{\n\tpublic void HandleEvent(EntityInserted eventMessage)\n\t{\n\t\tif (LicenseChecker.CheckState(\"MyCompany.MyPlugin\") == LicensingState.Unlicensed)\n\t\t\treturn;\n\t\t...","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Examples and Special Cases","type":"text"}]},{"type":"paragraph","content":[{"text":"LicenseChecker.CheckState()","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"LicenseChecker.Check()","type":"text","marks":[{"type":"code"}]},{"text":" are checking the license state against the current request URL or as a fallback against the current store URL (if there is no HTTP request object, which is usually the case in background tasks). The second parameter of these methods allows you to provide a different URL. The best example for this case is the promotion feed plugins. These plugins automatically create a feed file for each store (in a multi-store installation) within a background task. The creation of the feed file should be skipped if there is no active license for that particular store. ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public void CreateFeed(TaskExecutionContext context)\n{\n\t// fileCreation is of type FeedFileCreationContext (see Framework\\Plugins\\FeedPluginCore.cs)\n\tHelper.StartCreatingFeeds(fileCreation =>\n\t{\n\t\t// fileCreation.Store is an instance of the store entity\n\t\tvar result = LicenseChecker.Check(Helper.SystemName, fileCreation.Store.Url);\n\t\tif (result.State == LicensingState.Unlicensed)\n\t\t{\n\t\t\t// log the status check result into the log file and skip processing\n\t\t\tfileCreation.Logger.Error(result.ToString());\n\t\t\treturn true;\n\t\t}\n\t\t... create the feed file\n\t\treturn true;\n\t});\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Additionally, a payment plugin can hide its payment methods at checkout if there is no active license. To enable this to work, you must override the ","type":"text"},{"text":"PaymentMethodBase.IsActive","type":"text","marks":[{"type":"code"}]},{"text":" property. ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public override bool IsActive\n{\n\tget\n\t{\n\t\ttry\n\t\t{\n\t\t\tvar result = LicenseChecker.CheckState(\"MyCompany.MyExtraordinaryPlugin\");\n\t\t\treturn (result != LicensingState.Unlicensed);\n\t\t}\n\t\tcatch (Exception exc)\n\t\t{\n\t\t\t// _logger is an instance of ILogger\n\t\t\t_logger.InsertLog(LogLevel.Error, exc.Message, exc.ToString());\n\t\t}\n\t\treturn true;\n\t}\n}","type":"text"}]}],"version":1}

Browser not supported