| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +7× + + + +6× + + + + +1× + + + + +1× + + + + + + + + + + + + + + + + + + + +6× +5× +4× +3× + +2× + + + + + + + + +2× + +2× +2× +2× +2× +2× +2× +2× +2× +2× + + +2× + + +2× + + + + + + + + + +2× + + + + + + + + + +2× + +1× + +1× + +1× +1× +1× + +1× + + + + + + + + +6× +6× +6× +1× + + +5× + + + + + + + + +5× +5× +5× +1× + + +4× + + + + + + + + +4× +4× +4× +1× + + +3× + + + + + + + + +3× +3× +3× +1× + + +2× + + | pragma solidity ^0.4.24;
+
+// import Open Zeppelin contract for Owner function authorization
+import "../node_modules/openzeppelin-solidity/contracts/ownership/Ownable.sol";
+
+/// @title Media Gallery, upload media asset representations to Ethereum
+/// @author Graham Jackson
+//Date: 27 August 2018
+//Version: MediaGallery v1.0 Rinkeby
+/**
+ @dev This contract provides the ability to create a library of media assets
+ which are referenced via a hash and are meant to be stored/retrieved via
+ the inter-planetary file systme (IPFS).
+*/
+contract MediaGallery is Ownable {
+
+ bool public isStopped; //State variabe used to stop/start the contract
+ uint public mediaCounter; //A count of the total media assets added to the contract
+ uint public maximumNameLength = 125; //The maximum allowed length of a media asset name
+ uint public maximumDescLength = 250; //The maximum allowed length of a media asset description
+ uint public maximumTagsLength = 150; //The maximum allowed length of a media asset tags
+ uint public hashLength = 46; //The valid length of an IPFS hash
+
+ //Each poster address consists of an array of MediaAsset structs
+ //Used to store media assets, including the metadata associated with it, and to retrieve media
+ struct MediaAsset {
+ uint id; //Unique identifier for a media asset
+ string name; //Name of added media asset
+ string description; //Description of added media asset
+ address author; //Person who added the media assset
+ uint createDate; //Date and time the media asset was added via block.timestamp
+ string tags; //List of tags for added media asset
+ string mediaHash; //Multi-hash of the media to retrieve media from IPFS
+ string mediaType; //Type for media
+ string extension; //File Extension
+ }
+
+ //Database of Media assets. Each poster address has an array of MediaAssets
+ mapping(address => MediaAsset[]) public mediaDatabase;
+
+ //Event to log when a new media asset has been added
+ event LogNewMediaAsset(
+ uint indexed _id, //Unique identifier for the added media asseet
+ string _name, //Name of added media asset
+ address _author, //Address of person added media asset
+ uint _createDate, //Date and time the media asset was added
+ string _mediaHash, //Multi-hash of the added media asset
+ string _mediaType //Type of the added media asset
+ );
+
+ //Modifier to prevent particular functions from being run during a stoppage
+ modifier stoppedInEmergency {
+ require(
+ !isStopped,
+ "The contract has been stopped"
+ );
+ _;
+ }
+
+ /** @dev Stops the contract.*/
+ function stopContract() public onlyOwner {
+ isStopped = true;
+ }
+
+ /** @dev Resume the contract.*/
+ function resumeContract() public onlyOwner {
+ isStopped = false;
+ }
+
+ /**
+ * @dev Add mew media asset and trigger associted event.
+ * @param _name Name of the media asset.
+ * @param _description Description of the media asset.
+ * @param _mediaHash Multi-haash of the media asset.
+ * @param _tags List of tags for media asset.
+ * @param _mediaType File type of media asset.
+ * @param _extension File extension of media asset.
+ */
+ function addMedia(
+ string _name,
+ string _description,
+ string _mediaHash,
+ string _tags,
+ string _mediaType,
+ string _extension
+ ) public stoppedInEmergency {
+ require(validateName(_name), "Name is too long...");
+ require(validateDesc(_description), "Description is too long...");
+ require(validateTags(_tags), "Tags is too long...");
+ require(validateHashLength(_mediaHash), "Hash is too long...");
+ //Store media asset information in memory
+ MediaAsset memory currentMedia;
+ /*
+ Timestamp of the current block in seconds since the epoch.
+ Typically, it is not recommended to use the timestamp of a block
+ because there is no way to cryptographically verify the timestamp
+ and it can be manipulated by miners. However, in this case the
+ timestamp is purely informational and is not used for any validation
+ or action.
+ */
+ uint date = block.timestamp;
+
+ currentMedia.id = mediaCounter;
+ currentMedia.name = _name;
+ currentMedia.description = _description;
+ currentMedia.author = msg.sender;
+ currentMedia.createDate = date;
+ currentMedia.mediaHash = _mediaHash;
+ currentMedia.tags = _tags;
+ currentMedia.mediaType = _mediaType;
+ currentMedia.extension = _extension;
+
+ //Store the media asset in the database for the address of the sender
+ mediaDatabase[msg.sender].push(currentMedia);
+
+ //Emit the event for adding a media asset
+ emit LogNewMediaAsset(
+ mediaCounter,
+ _name,
+ msg.sender,
+ date,
+ _mediaHash,
+ _mediaType
+ );
+
+ //Increment the media counter to track total
+ mediaCounter++;
+ }
+
+ /**
+ * @dev Retrieve unique identifiers for media assets for a particular address.
+ * @param _user Address to retrieve media identifiers for.
+ * @return mediaAssetIds An array of media identifiers for provided address.
+ */
+ function getMediaByAddress(address _user) public view returns (uint[]) {
+ //Check to see if the address has provided any media assets yet
+ require(mediaDatabase[_user].length > 0, "No media found for this user");
+
+ uint[] memory mediaAssetIds = new uint[](mediaDatabase[_user].length);
+
+ uint numberOfMediaAssets = 0;
+
+ for(uint i = 0; i < mediaDatabase[_user].length; i++) {
+ mediaAssetIds[numberOfMediaAssets] = mediaDatabase[_user][i].id;
+ numberOfMediaAssets++;
+ }
+ return mediaAssetIds;
+ }
+
+ /**
+ * @dev Validate length of the name for a media asset.
+ * @param _name Proposed name for a media asset.
+ * @return A boolean value.
+ */
+ function validateName(string _name) private view returns(bool) {
+ bytes memory nameBytes = bytes(_name);
+ uint lengthBytes = nameBytes.length;
+ if (lengthBytes > maximumNameLength) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * @dev Validate length of the description for a media asset.
+ * @param _description Proposed description for a media asset.
+ * @return A boolean value.
+ */
+ function validateDesc(string _description) private view returns(bool) {
+ bytes memory descBytes = bytes(_description);
+ uint lengthBytes = descBytes.length;
+ if (lengthBytes > maximumDescLength) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * @dev Validate length of the tags for a media asset.
+ * @param _tags Proposed tags for a media asset.
+ * @return A boolean value.
+ */
+ function validateTags(string _tags) private view returns(bool) {
+ bytes memory tagsBytes = bytes(_tags);
+ uint lengthTags = tagsBytes.length;
+ if (lengthTags > maximumTagsLength) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * @dev Validate length of the IPFS hash for a media asset.
+ * @param _hash Proposed hash for a media asset.
+ * @return A boolean value.
+ */
+ function validateHashLength(string _hash) private view returns(bool) {
+ bytes memory hashBytes = bytes(_hash);
+ uint lengthHash = hashBytes.length;
+ if (lengthHash > hashLength) {
+ return false;
+ }
+
+ return true;
+ }
+} |
| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| MediaGallery.sol | +100% | +44/44 | +100% | +20/20 | +100% | +9/9 | +100% | +49/49 | +
| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| contracts/ | +100% | +44/44 | +100% | +20/20 | +100% | +9/9 | +100% | +49/49 | +
| 1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +7× + + + +6× + + + + +1× + + + + +1× + + + + + + + + + + + + + + + + + + + +6× +5× +4× +3× + +2× + + + + + + + + +2× + +2× +2× +2× +2× +2× +2× +2× +2× +2× + + +2× + + +2× + + + + + + + + + +2× + + + + + + + + + +2× + +1× + +1× + +1× +1× +1× + +1× + + + + + + + + +6× +6× +6× +1× + + +5× + + + + + + + + +5× +5× +5× +1× + + +4× + + + + + + + + +4× +4× +4× +1× + + +3× + + + + + + + + +3× +3× +3× +1× + + +2× + + | pragma solidity ^0.4.24;
+
+// import Open Zeppelin contract for Owner function authorization
+import "../node_modules/openzeppelin-solidity/contracts/ownership/Ownable.sol";
+
+/// @title Media Gallery, upload media asset representations to Ethereum
+/// @author Graham Jackson
+//Date: 27 August 2018
+//Version: MediaGallery v1.0 Rinkeby
+/**
+ @dev This contract provides the ability to create a library of media assets
+ which are referenced via a hash and are meant to be stored/retrieved via
+ the inter-planetary file systme (IPFS).
+*/
+contract MediaGallery is Ownable {
+
+ bool public isStopped; //State variabe used to stop/start the contract
+ uint public mediaCounter; //A count of the total media assets added to the contract
+ uint public maximumNameLength = 125; //The maximum allowed length of a media asset name
+ uint public maximumDescLength = 250; //The maximum allowed length of a media asset description
+ uint public maximumTagsLength = 150; //The maximum allowed length of a media asset tags
+ uint public hashLength = 46; //The valid length of an IPFS hash
+
+ //Each poster address consists of an array of MediaAsset structs
+ //Used to store media assets, including the metadata associated with it, and to retrieve media
+ struct MediaAsset {
+ uint id; //Unique identifier for a media asset
+ string name; //Name of added media asset
+ string description; //Description of added media asset
+ address author; //Person who added the media assset
+ uint createDate; //Date and time the media asset was added via block.timestamp
+ string tags; //List of tags for added media asset
+ string mediaHash; //Multi-hash of the media to retrieve media from IPFS
+ string mediaType; //Type for media
+ string extension; //File Extension
+ }
+
+ //Database of Media assets. Each poster address has an array of MediaAssets
+ mapping(address => MediaAsset[]) public mediaDatabase;
+
+ //Event to log when a new media asset has been added
+ event LogNewMediaAsset(
+ uint indexed _id, //Unique identifier for the added media asseet
+ string _name, //Name of added media asset
+ address _author, //Address of person added media asset
+ uint _createDate, //Date and time the media asset was added
+ string _mediaHash, //Multi-hash of the added media asset
+ string _mediaType //Type of the added media asset
+ );
+
+ //Modifier to prevent particular functions from being run during a stoppage
+ modifier stoppedInEmergency {
+ require(
+ !isStopped,
+ "The contract has been stopped"
+ );
+ _;
+ }
+
+ /** @dev Stops the contract.*/
+ function stopContract() public onlyOwner {
+ isStopped = true;
+ }
+
+ /** @dev Resume the contract.*/
+ function resumeContract() public onlyOwner {
+ isStopped = false;
+ }
+
+ /**
+ * @dev Add mew media asset and trigger associted event.
+ * @param _name Name of the media asset.
+ * @param _description Description of the media asset.
+ * @param _mediaHash Multi-haash of the media asset.
+ * @param _tags List of tags for media asset.
+ * @param _mediaType File type of media asset.
+ * @param _extension File extension of media asset.
+ */
+ function addMedia(
+ string _name,
+ string _description,
+ string _mediaHash,
+ string _tags,
+ string _mediaType,
+ string _extension
+ ) public stoppedInEmergency {
+ require(validateName(_name), "Name is too long...");
+ require(validateDesc(_description), "Description is too long...");
+ require(validateTags(_tags), "Tags is too long...");
+ require(validateHashLength(_mediaHash), "Hash is too long...");
+ //Store media asset information in memory
+ MediaAsset memory currentMedia;
+ /*
+ Timestamp of the current block in seconds since the epoch.
+ Typically, it is not recommended to use the timestamp of a block
+ because there is no way to cryptographically verify the timestamp
+ and it can be manipulated by miners. However, in this case the
+ timestamp is purely informational and is not used for any validation
+ or action.
+ */
+ uint date = block.timestamp;
+
+ currentMedia.id = mediaCounter;
+ currentMedia.name = _name;
+ currentMedia.description = _description;
+ currentMedia.author = msg.sender;
+ currentMedia.createDate = date;
+ currentMedia.mediaHash = _mediaHash;
+ currentMedia.tags = _tags;
+ currentMedia.mediaType = _mediaType;
+ currentMedia.extension = _extension;
+
+ //Store the media asset in the database for the address of the sender
+ mediaDatabase[msg.sender].push(currentMedia);
+
+ //Emit the event for adding a media asset
+ emit LogNewMediaAsset(
+ mediaCounter,
+ _name,
+ msg.sender,
+ date,
+ _mediaHash,
+ _mediaType
+ );
+
+ //Increment the media counter to track total
+ mediaCounter++;
+ }
+
+ /**
+ * @dev Retrieve unique identifiers for media assets for a particular address.
+ * @param _user Address to retrieve media identifiers for.
+ * @return mediaAssetIds An array of media identifiers for provided address.
+ */
+ function getMediaByAddress(address _user) public view returns (uint[]) {
+ //Check to see if the address has provided any media assets yet
+ require(mediaDatabase[_user].length > 0, "No media found for this user");
+
+ uint[] memory mediaAssetIds = new uint[](mediaDatabase[_user].length);
+
+ uint numberOfMediaAssets = 0;
+
+ for(uint i = 0; i < mediaDatabase[_user].length; i++) {
+ mediaAssetIds[numberOfMediaAssets] = mediaDatabase[_user][i].id;
+ numberOfMediaAssets++;
+ }
+ return mediaAssetIds;
+ }
+
+ /**
+ * @dev Validate length of the name for a media asset.
+ * @param _name Proposed name for a media asset.
+ * @return A boolean value.
+ */
+ function validateName(string _name) private view returns(bool) {
+ bytes memory nameBytes = bytes(_name);
+ uint lengthBytes = nameBytes.length;
+ if (lengthBytes > maximumNameLength) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * @dev Validate length of the description for a media asset.
+ * @param _description Proposed description for a media asset.
+ * @return A boolean value.
+ */
+ function validateDesc(string _description) private view returns(bool) {
+ bytes memory descBytes = bytes(_description);
+ uint lengthBytes = descBytes.length;
+ if (lengthBytes > maximumDescLength) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * @dev Validate length of the tags for a media asset.
+ * @param _tags Proposed tags for a media asset.
+ * @return A boolean value.
+ */
+ function validateTags(string _tags) private view returns(bool) {
+ bytes memory tagsBytes = bytes(_tags);
+ uint lengthTags = tagsBytes.length;
+ if (lengthTags > maximumTagsLength) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * @dev Validate length of the IPFS hash for a media asset.
+ * @param _hash Proposed hash for a media asset.
+ * @return A boolean value.
+ */
+ function validateHashLength(string _hash) private view returns(bool) {
+ bytes memory hashBytes = bytes(_hash);
+ uint lengthHash = hashBytes.length;
+ if (lengthHash > hashLength) {
+ return false;
+ }
+
+ return true;
+ }
+} |
| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| MediaGallery.sol | +100% | +44/44 | +100% | +20/20 | +100% | +9/9 | +100% | +49/49 | +
| File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
|---|---|---|---|---|---|---|---|---|---|
| contracts/ | +100% | +44/44 | +100% | +20/20 | +100% | +9/9 | +100% | +49/49 | +