blob: 07801a4c156a73218bd1bc7ab2acfa64346f7ef8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.felix.ipojo.manipulation;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.ByteArrayInputStream;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.InputStream;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Iterator;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Map;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.felix.ipojo.metadata.Attribute;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.objectweb.asm.ClassReader;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.objectweb.asm.ClassWriter;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.objectweb.asm.Opcodes;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * iPOJO Byte code Manipulator.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * @author &lt;a href="mailto:dev@felix.apache.org"&gt;Felix Project Team&lt;/a&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class Manipulator {<a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Store the visited fields : [name of the field, type of the field].<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span> private Map&lt;String, String&gt; m_fields;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Store the interface implemented by the class.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> private List&lt;String&gt; m_interfaces;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Store the methods list.<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> private List&lt;MethodDescriptor&gt; m_methods;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Pojo super class.<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> private String m_superClass;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * List of owned inner classed.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> private List&lt;String&gt; m_inners;<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Java byte code version.<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> private int m_version;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * Manipulate the given byte array.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @param origin : original class.<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @return the manipulated class, if the class is already manipulated, the original class.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @throws IOException : if an error occurs during the manipulation.<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> public byte[] manipulate(byte[] origin) throws IOException {<a name="line.77"></a>
<span class="sourceLineNo">078</span> InputStream is1 = new ByteArrayInputStream(origin);<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> // First check if the class is already manipulated :<a name="line.80"></a>
<span class="sourceLineNo">081</span> ClassReader ckReader = new ClassReader(is1);<a name="line.81"></a>
<span class="sourceLineNo">082</span> ClassChecker ck = new ClassChecker();<a name="line.82"></a>
<span class="sourceLineNo">083</span> ckReader.accept(ck, ClassReader.SKIP_FRAMES);<a name="line.83"></a>
<span class="sourceLineNo">084</span> is1.close();<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> m_fields = ck.getFields(); // Get visited fields (contains only POJO fields)<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> // Get interfaces and super class.<a name="line.88"></a>
<span class="sourceLineNo">089</span> m_interfaces = ck.getInterfaces();<a name="line.89"></a>
<span class="sourceLineNo">090</span> m_superClass = ck.getSuperClass();<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> // Get the methods list<a name="line.92"></a>
<span class="sourceLineNo">093</span> m_methods = ck.getMethods();<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> m_inners = ck.getInnerClasses();<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> m_version = ck.getClassVersion();<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> ClassWriter finalWriter = null;<a name="line.99"></a>
<span class="sourceLineNo">100</span> if (!ck.isalreadyManipulated()) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> // Manipulation -&gt;<a name="line.101"></a>
<span class="sourceLineNo">102</span> // Add the _setComponentManager method<a name="line.102"></a>
<span class="sourceLineNo">103</span> // Instrument all fields<a name="line.103"></a>
<span class="sourceLineNo">104</span> InputStream is2 = new ByteArrayInputStream(origin);<a name="line.104"></a>
<span class="sourceLineNo">105</span> ClassReader cr0 = new ClassReader(is2);<a name="line.105"></a>
<span class="sourceLineNo">106</span> ClassWriter cw0 = new ClassWriter(ClassWriter.COMPUTE_MAXS);<a name="line.106"></a>
<span class="sourceLineNo">107</span> //CheckClassAdapter ch = new CheckClassAdapter(cw0);<a name="line.107"></a>
<span class="sourceLineNo">108</span> MethodCreator preprocess = new MethodCreator(cw0, m_fields, m_methods);<a name="line.108"></a>
<span class="sourceLineNo">109</span> if (ck.getClassVersion() &gt;= Opcodes.V1_6) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> cr0.accept(preprocess, ClassReader.EXPAND_FRAMES);<a name="line.110"></a>
<span class="sourceLineNo">111</span> } else {<a name="line.111"></a>
<span class="sourceLineNo">112</span> cr0.accept(preprocess, 0);<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> is2.close();<a name="line.114"></a>
<span class="sourceLineNo">115</span> finalWriter = cw0;<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> // The file is in the bundle<a name="line.117"></a>
<span class="sourceLineNo">118</span> if (ck.isalreadyManipulated()) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return origin;<a name="line.119"></a>
<span class="sourceLineNo">120</span> } else {<a name="line.120"></a>
<span class="sourceLineNo">121</span> return finalWriter.toByteArray();<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
<span class="sourceLineNo">126</span> * Compute component type manipulation metadata.<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @return the manipulation metadata of the class.<a name="line.127"></a>
<span class="sourceLineNo">128</span> */<a name="line.128"></a>
<span class="sourceLineNo">129</span> public Element getManipulationMetadata() {<a name="line.129"></a>
<span class="sourceLineNo">130</span> Element elem = new Element("Manipulation", "");<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> if (m_superClass != null) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> elem.addAttribute(new Attribute("super", m_superClass));<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> for (int j = 0; j &lt; m_interfaces.size(); j++) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> Element itf = new Element("Interface", "");<a name="line.137"></a>
<span class="sourceLineNo">138</span> Attribute att = new Attribute("name", m_interfaces.get(j).toString());<a name="line.138"></a>
<span class="sourceLineNo">139</span> itf.addAttribute(att);<a name="line.139"></a>
<span class="sourceLineNo">140</span> elem.addElement(itf);<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> for (Iterator&lt;String&gt; it = m_fields.keySet().iterator(); it.hasNext();) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> Element field = new Element("Field", "");<a name="line.144"></a>
<span class="sourceLineNo">145</span> String name = it.next();<a name="line.145"></a>
<span class="sourceLineNo">146</span> String type = m_fields.get(name);<a name="line.146"></a>
<span class="sourceLineNo">147</span> Attribute attName = new Attribute("name", name);<a name="line.147"></a>
<span class="sourceLineNo">148</span> Attribute attType = new Attribute("type", type);<a name="line.148"></a>
<span class="sourceLineNo">149</span> field.addAttribute(attName);<a name="line.149"></a>
<span class="sourceLineNo">150</span> field.addAttribute(attType);<a name="line.150"></a>
<span class="sourceLineNo">151</span> elem.addElement(field);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> for (int j = 0; j &lt; m_methods.size(); j++) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> MethodDescriptor method = (MethodDescriptor) m_methods.get(j);<a name="line.155"></a>
<span class="sourceLineNo">156</span> elem.addElement(method.getElement());<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> return elem;<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> public Map&lt;String, String&gt; getFields() {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return m_fields;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> public List&lt;String&gt; getInnerClasses() {<a name="line.166"></a>
<span class="sourceLineNo">167</span> return m_inners;<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> public int getClassVersion() {<a name="line.170"></a>
<span class="sourceLineNo">171</span> return m_version;<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span>}<a name="line.173"></a>
</pre>
</div>
</body>
</html>