1 #region Copyright notice and license 2 // Protocol Buffers - Google's data interchange format 3 // Copyright 2015 Google Inc. All rights reserved. 4 // https://developers.google.com/protocol-buffers/ 5 // 6 // Redistribution and use in source and binary forms, with or without 7 // modification, are permitted provided that the following conditions are 8 // met: 9 // 10 // * Redistributions of source code must retain the above copyright 11 // notice, this list of conditions and the following disclaimer. 12 // * Redistributions in binary form must reproduce the above 13 // copyright notice, this list of conditions and the following disclaimer 14 // in the documentation and/or other materials provided with the 15 // distribution. 16 // * Neither the name of Google Inc. nor the names of its 17 // contributors may be used to endorse or promote products derived from 18 // this software without specific prior written permission. 19 // 20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 #endregion 32 33 using Google.Protobuf.Reflection; 34 35 namespace Google.Protobuf.WellKnownTypes 36 { 37 public partial class Any 38 { 39 private const string DefaultPrefix = "type.googleapis.com"; 40 41 // This could be moved to MessageDescriptor if we wanted to, but keeping it here means 42 // all the Any-specific code is in the same place. GetTypeUrl(MessageDescriptor descriptor, string prefix)43 private static string GetTypeUrl(MessageDescriptor descriptor, string prefix) => 44 prefix.EndsWith("/") ? prefix + descriptor.FullName : prefix + "/" + descriptor.FullName; 45 46 /// <summary> 47 /// Retrieves the type name for a type URL. This is always just the last part of the URL, 48 /// after the trailing slash. No validation of anything before the trailing slash is performed. 49 /// If the type URL does not include a slash, an empty string is returned rather than an exception 50 /// being thrown; this won't match any types, and the calling code is probably in a better position 51 /// to give a meaningful error. 52 /// There is no handling of fragments or queries at the moment. 53 /// </summary> 54 /// <param name="typeUrl">The URL to extract the type name from</param> 55 /// <returns>The type name</returns> GetTypeName(string typeUrl)56 internal static string GetTypeName(string typeUrl) 57 { 58 int lastSlash = typeUrl.LastIndexOf('/'); 59 return lastSlash == -1 ? "" : typeUrl.Substring(lastSlash + 1); 60 } 61 62 /// <summary> 63 /// Unpacks the content of this Any message into the target message type, 64 /// which must match the type URL within this Any message. 65 /// </summary> 66 /// <typeparam name="T">The type of message to unpack the content into.</typeparam> 67 /// <returns>The unpacked message.</returns> 68 /// <exception cref="InvalidProtocolBufferException">The target message type doesn't match the type URL in this message</exception> 69 public T Unpack<T>() where T : IMessage, new() 70 { 71 // Note: this doesn't perform as well is it might. We could take a MessageParser<T> in an alternative overload, 72 // which would be expected to perform slightly better... although the difference is likely to be negligible. 73 T target = new T(); 74 if (GetTypeName(TypeUrl) != target.Descriptor.FullName) 75 { 76 throw new InvalidProtocolBufferException( 77 $"Full type name for {target.Descriptor.Name} is {target.Descriptor.FullName}; Any message's type url is {TypeUrl}"); 78 } 79 target.MergeFrom(Value); 80 return target; 81 } 82 83 /// <summary> 84 /// Packs the specified message into an Any message using a type URL prefix of "type.googleapis.com". 85 /// </summary> 86 /// <param name="message">The message to pack.</param> 87 /// <returns>An Any message with the content and type URL of <paramref name="message"/>.</returns> 88 public static Any Pack(IMessage message) => Pack(message, DefaultPrefix); 89 90 /// <summary> 91 /// Packs the specified message into an Any message using the specified type URL prefix. 92 /// </summary> 93 /// <param name="message">The message to pack.</param> 94 /// <param name="typeUrlPrefix">The prefix for the type URL.</param> 95 /// <returns>An Any message with the content and type URL of <paramref name="message"/>.</returns> Pack(IMessage message, string typeUrlPrefix)96 public static Any Pack(IMessage message, string typeUrlPrefix) 97 { 98 ProtoPreconditions.CheckNotNull(message, nameof(message)); 99 ProtoPreconditions.CheckNotNull(typeUrlPrefix, nameof(typeUrlPrefix)); 100 return new Any 101 { 102 TypeUrl = GetTypeUrl(message.Descriptor, typeUrlPrefix), 103 Value = message.ToByteString() 104 }; 105 } 106 } 107 } 108